From 32d70fe9baa52a8c08f9ebd3fce21f96f0b50846 Mon Sep 17 00:00:00 2001 From: Andrea Angiolillo Date: Tue, 20 Aug 2024 11:50:03 +0100 Subject: [PATCH] CLOUDP-267019: [e2e test] Add an e2e scenario to test the changelog create [Part 1] (#179) --- .../changelog/new-version/base/changelog.json | 15493 +++++ .../changelog/new-version/base/metadata.json | 1 + .../new-version/base/openapi-2023-01-01.json | 49326 +++++++++++++++ .../new-version/base/openapi-2023-02-01.json | 50035 +++++++++++++++ .../new-version/base/openapi-2023-10-01.json | 50030 +++++++++++++++ .../new-version/base/openapi-2023-11-15.json | 50754 +++++++++++++++ .../new-version/base/openapi-2024-05-30.json | 51894 +++++++++++++++ .../changelog/new-version/exemptions.yaml | 3424 + .../output/2023-01-01_2023-02-01.json | 364 + .../output/2023-01-01_2023-10-01.json | 395 + .../output/2023-01-01_2023-11-15.json | 610 + .../output/2023-01-01_2024-05-30.json | 989 + .../output/2023-01-01_2024-08-05.json | 1060 + .../output/2023-02-01_2023-10-01.json | 33 + .../output/2023-02-01_2023-11-15.json | 248 + .../output/2023-02-01_2024-05-30.json | 627 + .../output/2023-02-01_2024-08-05.json | 1070 + .../output/2023-10-01_2023-11-15.json | 217 + .../output/2023-10-01_2024-05-30.json | 596 + .../output/2023-10-01_2024-08-05.json | 1039 + .../output/2023-11-15_2024-05-30.json | 381 + .../output/2023-11-15_2024-08-05.json | 824 + .../output/2024-05-30_2024-08-05.json | 445 + .../new-version/output/changelog-all.json | 16095 +++++ .../new-version/output/changelog.json | 16023 +++++ .../new-version/revision/exemptions.yaml | 5689 ++ .../new-version/revision/metadata.json | 1 + .../revision/openapi-2023-01-01.json | 49381 +++++++++++++++ .../revision/openapi-2023-02-01.json | 50090 +++++++++++++++ .../revision/openapi-2023-10-01.json | 50085 +++++++++++++++ .../revision/openapi-2023-11-15.json | 50809 +++++++++++++++ .../revision/openapi-2024-05-30.json | 51949 ++++++++++++++++ .../revision/openapi-2024-08-05.json | 51931 +++++++++++++++ tools/cli/test/e2e/cli/changelog_test.go | 130 + tools/cli/test/e2e/cli/cli.go | 28 + 35 files changed, 622066 insertions(+) create mode 100644 tools/cli/test/data/changelog/new-version/base/changelog.json create mode 100644 tools/cli/test/data/changelog/new-version/base/metadata.json create mode 100644 tools/cli/test/data/changelog/new-version/base/openapi-2023-01-01.json create mode 100644 tools/cli/test/data/changelog/new-version/base/openapi-2023-02-01.json create mode 100644 tools/cli/test/data/changelog/new-version/base/openapi-2023-10-01.json create mode 100644 tools/cli/test/data/changelog/new-version/base/openapi-2023-11-15.json create mode 100644 tools/cli/test/data/changelog/new-version/base/openapi-2024-05-30.json create mode 100644 tools/cli/test/data/changelog/new-version/exemptions.yaml create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-02-01.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-10-01.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-11-15.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-01-01_2024-05-30.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-01-01_2024-08-05.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-02-01_2023-10-01.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-02-01_2023-11-15.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-02-01_2024-05-30.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-02-01_2024-08-05.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-10-01_2023-11-15.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-10-01_2024-05-30.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-10-01_2024-08-05.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-11-15_2024-05-30.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2023-11-15_2024-08-05.json create mode 100644 tools/cli/test/data/changelog/new-version/output/2024-05-30_2024-08-05.json create mode 100644 tools/cli/test/data/changelog/new-version/output/changelog-all.json create mode 100644 tools/cli/test/data/changelog/new-version/output/changelog.json create mode 100644 tools/cli/test/data/changelog/new-version/revision/exemptions.yaml create mode 100644 tools/cli/test/data/changelog/new-version/revision/metadata.json create mode 100644 tools/cli/test/data/changelog/new-version/revision/openapi-2023-01-01.json create mode 100644 tools/cli/test/data/changelog/new-version/revision/openapi-2023-02-01.json create mode 100644 tools/cli/test/data/changelog/new-version/revision/openapi-2023-10-01.json create mode 100644 tools/cli/test/data/changelog/new-version/revision/openapi-2023-11-15.json create mode 100644 tools/cli/test/data/changelog/new-version/revision/openapi-2024-05-30.json create mode 100644 tools/cli/test/data/changelog/new-version/revision/openapi-2024-08-05.json create mode 100644 tools/cli/test/e2e/cli/changelog_test.go diff --git a/tools/cli/test/data/changelog/new-version/base/changelog.json b/tools/cli/test/data/changelog/new-version/base/changelog.json new file mode 100644 index 000000000..2c148efee --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/base/changelog.json @@ -0,0 +1,15493 @@ +[ + { + "date": "2024-08-07", + "paths": [ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #1: OIDC WORKFORCE]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #2: OIDC WORKLOAD]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property 'protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createIdentityProvider", + "tag": "Federated Authentication" + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #1: SAML]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #2: OIDC WORKFORCE]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #3: OIDC WORKLOAD]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property 'protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "addProjectApiKey", + "tag": "Programmatic API Keys" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the request optional property 'customShardKey' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'isCustomShardKeyHashed' became write-only", + "changeCode": "request-optional-property-became-write-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'isShardKeyUnique' became write-only", + "changeCode": "request-optional-property-became-write-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'numInitialChunks' became write-only", + "changeCode": "request-optional-property-became-write-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'presplitHashedZones' became write-only", + "changeCode": "request-optional-property-became-write-only", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createManagedNamespace", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'PENDING' enum value to the 'results/items/delivery/statusName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listLegacyBackupRestoreJobs", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'PENDING' enum value to the 'results/items/delivery/statusName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'PENDING' enum value to the request property 'delivery/statusName'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createLegacyBackupRestoreJob", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'PENDING' enum value to the 'delivery/statusName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getLegacyBackupRestoreJob", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/dataFederation", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added 'azure' discriminator mapping keys to the '/items/storage/stores/items/' response property", + "changeCode": "response-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the '/items/storage/stores/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listFederatedDatabases", + "tag": "Data Federation" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/dataFederation", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' request property", + "changeCode": "request-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' response property", + "changeCode": "response-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createFederatedDatabase", + "tag": "Data Federation" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' response property", + "changeCode": "response-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getFederatedDatabase", + "tag": "Data Federation" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' request property", + "changeCode": "request-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' response property", + "changeCode": "response-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateFederatedDatabase", + "tag": "Data Federation" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/encryptionAtRest", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional property 'azureKeyVault/requirePrivateNetworking' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getEncryptionAtRest", + "tag": "Encryption at Rest using Customer Key Management" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/encryptionAtRest", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional property 'azureKeyVault/requirePrivateNetworking' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'azureKeyVault/requirePrivateNetworking'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateEncryptionAtRest", + "tag": "Encryption at Rest using Customer Key Management" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/events", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'ATLAS_SQL_SCHEDULED_UPDATE_CREATED, ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED, ATLAS_SQL_SCHEDULED_UPDATE_REMOVED, INDEPENDENT_SHARD_SCALING_AVAILABLE, QUEUED_ADMIN_ACTION_CREATED' enum values to the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'CLUSTER_FCV_DOWNGRADED' enum value to the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #32: Version Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listProjectEvents", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/events/{eventId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'ATLAS_SQL_SCHEDULED_UPDATE_CREATED, ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED, ATLAS_SQL_SCHEDULED_UPDATE_REMOVED, INDEPENDENT_SHARD_SCALING_AVAILABLE, QUEUED_ADMIN_ACTION_CREATED' enum values to the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'CLUSTER_FCV_DOWNGRADED' enum value to the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #32: Version Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getProjectEvent", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "getStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "listStreamProcessors", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/events", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'SECURITY_CONTACT_MODIFIED' enum value to the 'results/items/oneOf[subschema #8: Org Events]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listOrganizationEvents", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/events/{eventId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'SECURITY_CONTACT_MODIFIED' enum value to the '/oneOf[subschema #8: Org Events]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getOrganizationEvent", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/invoices", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new optional 'query' request parameter 'fromDate'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + }, + { + "change": "added the new optional 'query' request parameter 'orderBy'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + }, + { + "change": "added the new optional 'query' request parameter 'sortBy'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + }, + { + "change": "added the new optional 'query' request parameter 'statusNames'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + }, + { + "change": "added the new optional 'query' request parameter 'toDate'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listInvoices", + "tag": "Invoices" + } + ] + }, + { + "date": "2024-07-24", + "paths": [ + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the response properties 'results/items/bucketName, results/items/cloudProvider, results/items/iamRoleId, results/items/roleId, results/items/serviceUrl, results/items/tenantId' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listExportBuckets", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the '/bucketName' request property's maxLength was set to '63'", + "changeCode": "request-property-max-length-set", + "backwardCompatible": true + }, + { + "change": "the '/bucketName' request property's maxLength was set to '63'", + "changeCode": "request-property-max-length-set", + "backwardCompatible": true + }, + { + "change": "the '/serviceUrl' request property's maxLength was set to '55'", + "changeCode": "request-property-max-length-set", + "backwardCompatible": true + }, + { + "change": "the 'bucketName' request property's maxLength was set to '63'", + "changeCode": "request-property-max-length-set", + "backwardCompatible": true + }, + { + "change": "the response properties '/bucketName, /cloudProvider, /iamRoleId, /roleId, /serviceUrl, /tenantId, bucketName, cloudProvider' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createExportBucket", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "changed the pattern of the 'path' request parameter 'exportBucketId' from '^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,61}[a-z0-9])$' to '^([a-f0-9]{24})$'", + "changeCode": "request-parameter-pattern-changed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "deleteExportBucket", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "changed the pattern of the 'path' request parameter 'exportBucketId' from '^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,61}[a-z0-9])$' to '^([a-f0-9]{24})$'", + "changeCode": "request-parameter-pattern-changed", + "backwardCompatible": true + }, + { + "change": "the response properties '/bucketName, /cloudProvider, /iamRoleId, /roleId, /serviceUrl, /tenantId, bucketName, cloudProvider' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getExportBucket", + "tag": "Cloud Backups" + } + ] + }, + { + "date": "2024-07-18", + "paths": [ + { + "path": "/api/atlas/v2/eventTypes", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional properties 'links, results, totalCount' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listEventTypes", + "tag": "Events" + } + ] + }, + { + "date": "2024-07-13", + "paths": [ + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "deleteStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "startStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "stopStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/events", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'ORG_NO_FINANCIAL_PROTECTION, ORG_UNDER_FINANCIAL_PROTECTION' enum values to the 'results/items/oneOf[subschema #8: Org Events]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listOrganizationEvents", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/events/{eventId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'ORG_NO_FINANCIAL_PROTECTION, ORG_UNDER_FINANCIAL_PROTECTION' enum values to the '/oneOf[subschema #8: Org Events]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getOrganizationEvent", + "tag": "Events" + } + ] + }, + { + "date": "2024-07-11", + "paths": [ + { + "path": "/api/atlas/v2/eventTypes", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "listEventTypes", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listAlertConfigurations", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + }, + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the enum value 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/'", + "changeCode": "request-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createAlertConfiguration", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getAlertConfiguration", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "toggleAlertConfiguration", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}", + "httpMethod": "PUT", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + }, + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the enum value 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/'", + "changeCode": "request-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateAlertConfiguration", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #14: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listAlertsByAlertConfigurationId", + "tag": "Alerts" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #14: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listAlerts", + "tag": "Alerts" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #14: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getAlert", + "tag": "Alerts" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #14: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "acknowledgeAlert", + "tag": "Alerts" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listAlertConfigurationsByAlertId", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listClusters", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' request property default value '7.0' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' request property default value '7.0' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "upgradeSharedCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' request property default value '7.0' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional write-only property 'deleteCopiedBackups/items/zoneId' to the response", + "changeCode": "response-optional-write-only-property-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "deleteAllBackupSchedules", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional write-only property 'deleteCopiedBackups/items/zoneId' to the response", + "changeCode": "response-optional-write-only-property-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getBackupSchedule", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional write-only property 'deleteCopiedBackups/items/zoneId' to the response", + "changeCode": "response-optional-write-only-property-added", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'deleteCopiedBackups/items/zoneId'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateBackupSchedule", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'CONFIG_SHARD_REPLICA_SET' enum value to the 'results/items/parts/items/typeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listLegacySnapshots", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'CONFIG_SHARD_REPLICA_SET' enum value to the 'parts/items/typeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getLegacySnapshot", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'CONFIG_SHARD_REPLICA_SET' enum value to the 'parts/items/typeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'CONFIG_SHARD_REPLICA_SET' enum value to the request property 'parts/items/typeName'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateLegacySnapshotRetention", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/customDBRoles/roles", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the '/items/inheritedRoles/items/role' response's property pattern '^\\b(?!xgen-)([0-9A-Za-z_\\-]+)\\b(? Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + }, + "patch" : { + "deprecated" : true, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "patch" : { + "deprecated" : true, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertView" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2024-10-01" + }, + "put" : { + "deprecated" : true, + "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.", + "operationId" : "updateDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-sunset" : "2024-10-01", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2024-10-01" + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedLegacyClusterView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ] + }, + "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.", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" : { + "delete" : { + "deprecated" : true, + "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.", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2025-06-01" + }, + "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.", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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.", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "description" : "Returns 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 Read Only role.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + }, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "deprecated" : true, + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "get" : { + "deprecated" : true, + "description" : "Return the Search Nodes for the specified cluster.", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the Search Nodes for the specified cluster.", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" : { + "get" : { + "deprecated" : true, + "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\".", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ], + "x-sunset" : "2025-06-01" + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "deprecated" : true, + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster.", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20250101" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20250101", + "AZURE" : "#/components/schemas/AzureRegionConfig20250101", + "GCP" : "#/components/schemas/GCPRegionConfig20250101", + "TENANT" : "#/components/schemas/TenantRegionConfig20250101" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20250101" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20250101" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20250101" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20250101" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20250101" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20250101" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20250101" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20250101" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20250101" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20250101" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20250101" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20250101" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20250101" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data." + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/base/openapi-2023-02-01.json b/tools/cli/test/data/changelog/new-version/base/openapi-2023-02-01.json new file mode 100644 index 000000000..f87cdf6f9 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/base/openapi-2023-02-01.json @@ -0,0 +1,50035 @@ +{ + "openapi" : "3.0.1", + "info" : { + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\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\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "license" : { + "name" : "CC BY-NC-SA 3.0 US", + "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + }, + "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "title" : "MongoDB Atlas Administration API", + "version" : "2.0", + "x-xgen-sha" : "63cbfec3f6eeceb446c1d2641263b0628f04f450" + }, + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "tags" : [ { + "description" : "Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.", + "name" : "Access Tracking" + }, { + "description" : "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.", + "name" : "Alert Configurations" + }, { + "description" : "Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.", + "name" : "Alerts" + }, { + "description" : "Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.", + "name" : "Atlas Search" + }, { + "description" : "Returns and edits database auditing settings for MongoDB Cloud projects.", + "name" : "Auditing" + }, { + "description" : "Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.", + "name" : "AWS Clusters DNS" + }, { + "description" : "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.", + "name" : "Cloud Backups" + }, { + "description" : "Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.", + "name" : "Cloud Migration Service" + }, { + "description" : "Returns, adds, authorizes, and removes AWS IAM roles in Atlas.", + "name" : "Cloud Provider Access" + }, { + "description" : "Returns, starts, or ends a cluster outage simulation.", + "name" : "Cluster Outage Simulation" + }, { + "description" : "Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.", + "name" : "Clusters" + }, { + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.", + "name" : "Collection Level Metrics" + }, { + "description" : "Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.", + "name" : "Custom Database Roles" + }, { + "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", + "name" : "Data Federation" + }, { + "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "name" : "Data Lake Pipelines" + }, { + "description" : "Returns, adds, edits, and removes database users.", + "name" : "Database Users" + }, { + "description" : "Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "name" : "Encryption at Rest using Customer Key Management" + }, { + "description" : "Returns events. This collection remains under revision and may change.", + "name" : "Events" + }, { + "description" : "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.", + "name" : "Federated Authentication" + }, { + "description" : "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.\nMongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.", + "name" : "Global Clusters" + }, { + "description" : "Returns invoices.", + "name" : "Invoices" + }, { + "description" : "Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.", + "name" : "LDAP Configuration" + }, { + "description" : "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.", + "name" : "Legacy Backup" + }, { + "description" : "Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.", + "name" : "Maintenance Windows" + }, { + "description" : "Returns, adds, and edits MongoDB Cloud users.", + "name" : "MongoDB Cloud Users" + }, { + "description" : "Returns database deployment monitoring and logging data.", + "name" : "Monitoring and Logs" + }, { + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.", + "name" : "Network Peering" + }, { + "description" : "Returns, adds, edits, or removes an online archive.", + "name" : "Online Archive" + }, { + "description" : "Returns, adds, and edits organizational units in MongoDB Cloud.", + "name" : "Organizations" + }, { + "description" : "Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.", + "name" : "Performance Advisor" + }, { + "description" : "Returns, adds, edits, and removes private endpoint services.", + "name" : "Private Endpoint Services" + }, { + "description" : "Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.", + "name" : "Programmatic API Keys" + }, { + "description" : "Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.", + "name" : "Project IP Access List" + }, { + "description" : "Returns, adds, and edits collections of clusters and users in MongoDB Cloud.", + "name" : "Projects" + }, { + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", + "name" : "Push-Based Log Export" + }, { + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", + "name" : "Rolling Index" + }, { + "description" : "Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.", + "name" : "Root" + }, { + "description" : "Returns, adds, edits, and removes serverless instances.", + "name" : "Serverless Instances" + }, { + "description" : "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "name" : "Serverless Private Endpoints" + }, { + "description" : "Returns and adds restore jobs for shared-tier database deployments.", + "name" : "Shared-Tier Restore Jobs" + }, { + "description" : "Returns and requests to download shared-tier database deployment snapshots.", + "name" : "Shared-Tier Snapshots" + }, { + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.", + "name" : "Streams" + }, { + "description" : "Returns, adds, edits, or removes teams.", + "name" : "Teams" + }, { + "description" : "Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.\n\n**IMPORTANT**: Each project can only have one configuration per integrationType.", + "name" : "Third-Party Integrations" + }, { + "description" : "Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.", + "externalDocs" : { + "description" : "Self-Managed X.509 Certificates", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/" + }, + "name" : "X.509 Authentication" + } ], + "paths" : { + "/api/atlas/v2" : { + "get" : { + "description" : "This resource returns information about the MongoDB application along with API key meta data.", + "operationId" : "getSystemStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized." + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the status of this MongoDB application", + "tags" : [ "Root" ] + } + }, + "/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.", + "operationId" : "listAlertConfigurationMatchersFieldNames", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get All Alert Configuration Matchers Field Names", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "operationId" : "listClustersForAllProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Authorized Clusters in All Projects", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/eventTypes" : { + "get" : { + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "List All Possible Event Types", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "deleteFederationApp", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Federation Settings Instance", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connected Org Configs from One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "description" : "The connected organization configuration that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listRoleMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Role Mappings from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Role Mapping to One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "deleteRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Role Mapping in One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listIdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "The protocols of the target identity providers.", + "in" : "query", + "name" : "protocol", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "description" : "The types of the target identity providers.", + "in" : "query", + "name" : "idpType", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + } + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Identity Providers in One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + }, + "patch" : { + "deprecated" : true, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Adds one MongoDB Cloud user to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "204" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One MongoDB Cloud User to One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "patch" : { + "deprecated" : true, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertView" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2024-10-01" + }, + "put" : { + "deprecated" : true, + "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.", + "operationId" : "updateDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-sunset" : "2024-10-01", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2024-10-01" + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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-01-01}", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAdvancedClusterDescriptionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "description" : "Returns 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 Read Only role. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ] + } + }, + "/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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + }, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "deprecated" : true, + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "get" : { + "deprecated" : true, + "description" : "Return the Search Nodes for the specified cluster.", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the Search Nodes for the specified cluster.", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "deprecated" : true, + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster.", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to create one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20250101" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20250101", + "AZURE" : "#/components/schemas/AzureRegionConfig20250101", + "GCP" : "#/components/schemas/GCPRegionConfig20250101", + "TENANT" : "#/components/schemas/TenantRegionConfig20250101" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20250101" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20250101" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20250101" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20250101" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20250101" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20250101" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20250101" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20250101" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20250101" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20250101" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20250101" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20250101" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20250101" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data." + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/base/openapi-2023-10-01.json b/tools/cli/test/data/changelog/new-version/base/openapi-2023-10-01.json new file mode 100644 index 000000000..075eb83f8 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/base/openapi-2023-10-01.json @@ -0,0 +1,50030 @@ +{ + "openapi" : "3.0.1", + "info" : { + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\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\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "license" : { + "name" : "CC BY-NC-SA 3.0 US", + "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + }, + "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "title" : "MongoDB Atlas Administration API", + "version" : "2.0", + "x-xgen-sha" : "63cbfec3f6eeceb446c1d2641263b0628f04f450" + }, + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "tags" : [ { + "description" : "Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.", + "name" : "Access Tracking" + }, { + "description" : "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.", + "name" : "Alert Configurations" + }, { + "description" : "Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.", + "name" : "Alerts" + }, { + "description" : "Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.", + "name" : "Atlas Search" + }, { + "description" : "Returns and edits database auditing settings for MongoDB Cloud projects.", + "name" : "Auditing" + }, { + "description" : "Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.", + "name" : "AWS Clusters DNS" + }, { + "description" : "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.", + "name" : "Cloud Backups" + }, { + "description" : "Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.", + "name" : "Cloud Migration Service" + }, { + "description" : "Returns, adds, authorizes, and removes AWS IAM roles in Atlas.", + "name" : "Cloud Provider Access" + }, { + "description" : "Returns, starts, or ends a cluster outage simulation.", + "name" : "Cluster Outage Simulation" + }, { + "description" : "Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.", + "name" : "Clusters" + }, { + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.", + "name" : "Collection Level Metrics" + }, { + "description" : "Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.", + "name" : "Custom Database Roles" + }, { + "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", + "name" : "Data Federation" + }, { + "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "name" : "Data Lake Pipelines" + }, { + "description" : "Returns, adds, edits, and removes database users.", + "name" : "Database Users" + }, { + "description" : "Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "name" : "Encryption at Rest using Customer Key Management" + }, { + "description" : "Returns events. This collection remains under revision and may change.", + "name" : "Events" + }, { + "description" : "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.", + "name" : "Federated Authentication" + }, { + "description" : "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.\nMongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.", + "name" : "Global Clusters" + }, { + "description" : "Returns invoices.", + "name" : "Invoices" + }, { + "description" : "Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.", + "name" : "LDAP Configuration" + }, { + "description" : "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.", + "name" : "Legacy Backup" + }, { + "description" : "Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.", + "name" : "Maintenance Windows" + }, { + "description" : "Returns, adds, and edits MongoDB Cloud users.", + "name" : "MongoDB Cloud Users" + }, { + "description" : "Returns database deployment monitoring and logging data.", + "name" : "Monitoring and Logs" + }, { + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.", + "name" : "Network Peering" + }, { + "description" : "Returns, adds, edits, or removes an online archive.", + "name" : "Online Archive" + }, { + "description" : "Returns, adds, and edits organizational units in MongoDB Cloud.", + "name" : "Organizations" + }, { + "description" : "Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.", + "name" : "Performance Advisor" + }, { + "description" : "Returns, adds, edits, and removes private endpoint services.", + "name" : "Private Endpoint Services" + }, { + "description" : "Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.", + "name" : "Programmatic API Keys" + }, { + "description" : "Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.", + "name" : "Project IP Access List" + }, { + "description" : "Returns, adds, and edits collections of clusters and users in MongoDB Cloud.", + "name" : "Projects" + }, { + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", + "name" : "Push-Based Log Export" + }, { + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", + "name" : "Rolling Index" + }, { + "description" : "Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.", + "name" : "Root" + }, { + "description" : "Returns, adds, edits, and removes serverless instances.", + "name" : "Serverless Instances" + }, { + "description" : "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "name" : "Serverless Private Endpoints" + }, { + "description" : "Returns and adds restore jobs for shared-tier database deployments.", + "name" : "Shared-Tier Restore Jobs" + }, { + "description" : "Returns and requests to download shared-tier database deployment snapshots.", + "name" : "Shared-Tier Snapshots" + }, { + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.", + "name" : "Streams" + }, { + "description" : "Returns, adds, edits, or removes teams.", + "name" : "Teams" + }, { + "description" : "Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.\n\n**IMPORTANT**: Each project can only have one configuration per integrationType.", + "name" : "Third-Party Integrations" + }, { + "description" : "Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.", + "externalDocs" : { + "description" : "Self-Managed X.509 Certificates", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/" + }, + "name" : "X.509 Authentication" + } ], + "paths" : { + "/api/atlas/v2" : { + "get" : { + "description" : "This resource returns information about the MongoDB application along with API key meta data.", + "operationId" : "getSystemStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized." + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the status of this MongoDB application", + "tags" : [ "Root" ] + } + }, + "/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.", + "operationId" : "listAlertConfigurationMatchersFieldNames", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get All Alert Configuration Matchers Field Names", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "operationId" : "listClustersForAllProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Authorized Clusters in All Projects", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/eventTypes" : { + "get" : { + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "List All Possible Event Types", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "deleteFederationApp", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Federation Settings Instance", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connected Org Configs from One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "description" : "The connected organization configuration that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listRoleMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Role Mappings from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Role Mapping to One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "deleteRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Role Mapping in One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listIdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "The protocols of the target identity providers.", + "in" : "query", + "name" : "protocol", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "description" : "The types of the target identity providers.", + "in" : "query", + "name" : "idpType", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + } + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Identity Providers in One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + }, + "patch" : { + "deprecated" : true, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Adds one MongoDB Cloud user to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "204" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One MongoDB Cloud User to One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "patch" : { + "deprecated" : true, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertView" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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}", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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-01-01}", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAdvancedClusterDescriptionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "description" : "Returns 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 Read Only role. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ] + } + }, + "/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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + }, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "deprecated" : true, + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "get" : { + "deprecated" : true, + "description" : "Return the Search Nodes for the specified cluster.", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the Search Nodes for the specified cluster.", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "deprecated" : true, + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster.", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to create one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20250101" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20250101", + "AZURE" : "#/components/schemas/AzureRegionConfig20250101", + "GCP" : "#/components/schemas/GCPRegionConfig20250101", + "TENANT" : "#/components/schemas/TenantRegionConfig20250101" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20250101" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20250101" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20250101" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20250101" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20250101" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20250101" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20250101" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20250101" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20250101" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20250101" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20250101" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20250101" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20250101" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data." + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/base/openapi-2023-11-15.json b/tools/cli/test/data/changelog/new-version/base/openapi-2023-11-15.json new file mode 100644 index 000000000..546238a25 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/base/openapi-2023-11-15.json @@ -0,0 +1,50754 @@ +{ + "openapi" : "3.0.1", + "info" : { + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\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\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "license" : { + "name" : "CC BY-NC-SA 3.0 US", + "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + }, + "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "title" : "MongoDB Atlas Administration API", + "version" : "2.0", + "x-xgen-sha" : "63cbfec3f6eeceb446c1d2641263b0628f04f450" + }, + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "tags" : [ { + "description" : "Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.", + "name" : "Access Tracking" + }, { + "description" : "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.", + "name" : "Alert Configurations" + }, { + "description" : "Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.", + "name" : "Alerts" + }, { + "description" : "Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.", + "name" : "Atlas Search" + }, { + "description" : "Returns and edits database auditing settings for MongoDB Cloud projects.", + "name" : "Auditing" + }, { + "description" : "Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.", + "name" : "AWS Clusters DNS" + }, { + "description" : "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.", + "name" : "Cloud Backups" + }, { + "description" : "Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.", + "name" : "Cloud Migration Service" + }, { + "description" : "Returns, adds, authorizes, and removes AWS IAM roles in Atlas.", + "name" : "Cloud Provider Access" + }, { + "description" : "Returns, starts, or ends a cluster outage simulation.", + "name" : "Cluster Outage Simulation" + }, { + "description" : "Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.", + "name" : "Clusters" + }, { + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.", + "name" : "Collection Level Metrics" + }, { + "description" : "Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.", + "name" : "Custom Database Roles" + }, { + "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", + "name" : "Data Federation" + }, { + "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "name" : "Data Lake Pipelines" + }, { + "description" : "Returns, adds, edits, and removes database users.", + "name" : "Database Users" + }, { + "description" : "Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "name" : "Encryption at Rest using Customer Key Management" + }, { + "description" : "Returns events. This collection remains under revision and may change.", + "name" : "Events" + }, { + "description" : "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.", + "name" : "Federated Authentication" + }, { + "description" : "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.\nMongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.", + "name" : "Global Clusters" + }, { + "description" : "Returns invoices.", + "name" : "Invoices" + }, { + "description" : "Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.", + "name" : "LDAP Configuration" + }, { + "description" : "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.", + "name" : "Legacy Backup" + }, { + "description" : "Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.", + "name" : "Maintenance Windows" + }, { + "description" : "Returns, adds, and edits MongoDB Cloud users.", + "name" : "MongoDB Cloud Users" + }, { + "description" : "Returns database deployment monitoring and logging data.", + "name" : "Monitoring and Logs" + }, { + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.", + "name" : "Network Peering" + }, { + "description" : "Returns, adds, edits, or removes an online archive.", + "name" : "Online Archive" + }, { + "description" : "Returns, adds, and edits organizational units in MongoDB Cloud.", + "name" : "Organizations" + }, { + "description" : "Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.", + "name" : "Performance Advisor" + }, { + "description" : "Returns, adds, edits, and removes private endpoint services.", + "name" : "Private Endpoint Services" + }, { + "description" : "Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.", + "name" : "Programmatic API Keys" + }, { + "description" : "Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.", + "name" : "Project IP Access List" + }, { + "description" : "Returns, adds, and edits collections of clusters and users in MongoDB Cloud.", + "name" : "Projects" + }, { + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", + "name" : "Push-Based Log Export" + }, { + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", + "name" : "Rolling Index" + }, { + "description" : "Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.", + "name" : "Root" + }, { + "description" : "Returns, adds, edits, and removes serverless instances.", + "name" : "Serverless Instances" + }, { + "description" : "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "name" : "Serverless Private Endpoints" + }, { + "description" : "Returns and adds restore jobs for shared-tier database deployments.", + "name" : "Shared-Tier Restore Jobs" + }, { + "description" : "Returns and requests to download shared-tier database deployment snapshots.", + "name" : "Shared-Tier Snapshots" + }, { + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.", + "name" : "Streams" + }, { + "description" : "Returns, adds, edits, or removes teams.", + "name" : "Teams" + }, { + "description" : "Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.\n\n**IMPORTANT**: Each project can only have one configuration per integrationType.", + "name" : "Third-Party Integrations" + }, { + "description" : "Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.", + "externalDocs" : { + "description" : "Self-Managed X.509 Certificates", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/" + }, + "name" : "X.509 Authentication" + } ], + "paths" : { + "/api/atlas/v2" : { + "get" : { + "description" : "This resource returns information about the MongoDB application along with API key meta data.", + "operationId" : "getSystemStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized." + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the status of this MongoDB application", + "tags" : [ "Root" ] + } + }, + "/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.", + "operationId" : "listAlertConfigurationMatchersFieldNames", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get All Alert Configuration Matchers Field Names", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "operationId" : "listClustersForAllProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Authorized Clusters in All Projects", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/eventTypes" : { + "get" : { + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "List All Possible Event Types", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "deleteFederationApp", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Federation Settings Instance", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connected Org Configs from One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "description" : "The connected organization configuration that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listRoleMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Role Mappings from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Role Mapping to One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "deleteRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Role Mapping in One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listIdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "The protocols of the target identity providers.", + "in" : "query", + "name" : "protocol", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "description" : "The types of the target identity providers.", + "in" : "query", + "name" : "idpType", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + } + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Identity Providers in One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: This resource only supports the creation of OIDC identity providers.", + "operationId" : "createIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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/).", + "operationId" : "deleteIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Identity Provider", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. Deprecated versions: v2-{2023-01-01}", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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).", + "operationId" : "revokeJwksFromIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke the JWKS from One OIDC Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Adds one MongoDB Cloud user to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "204" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One MongoDB Cloud User to One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "patch" : { + "deprecated" : true, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertView" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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}", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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-01-01}", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAdvancedClusterDescriptionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getPinnedNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve pinned namespaces for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pin Namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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", + "operationId" : "unpinNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to unpin namespaces from.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unpin namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "description" : "Returns 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 Read Only role. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ] + } + }, + "/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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + }, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "deprecated" : true, + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "get" : { + "deprecated" : true, + "description" : "Return the Search Nodes for the specified cluster.", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the Search Nodes for the specified cluster.", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Cluster", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceClusterMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve metrics for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "explode" : true, + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given cluster", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyCluster" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Cluster-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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}", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all metric names", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "deprecated" : true, + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster.", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForHost", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Host", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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", + "operationId" : "getCollStatsLatencyNamespaceHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given process", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + } + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyHost" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Host-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to create one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/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).", + "operationId" : "returnAllControlPlaneIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/ControlPlaneIPAddresses" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "summary" : "Return All Control Plane IP Addresses", + "tags" : [ "Root" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20250101" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20250101", + "AZURE" : "#/components/schemas/AzureRegionConfig20250101", + "GCP" : "#/components/schemas/GCPRegionConfig20250101", + "TENANT" : "#/components/schemas/TenantRegionConfig20250101" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20250101" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20250101" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20250101" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20250101" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20250101" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20250101" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20250101" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20250101" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20250101" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20250101" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20250101" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20250101" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20250101" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data." + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/base/openapi-2024-05-30.json b/tools/cli/test/data/changelog/new-version/base/openapi-2024-05-30.json new file mode 100644 index 000000000..b2d8c138c --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/base/openapi-2024-05-30.json @@ -0,0 +1,51894 @@ +{ + "openapi" : "3.0.1", + "info" : { + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\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\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "license" : { + "name" : "CC BY-NC-SA 3.0 US", + "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + }, + "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "title" : "MongoDB Atlas Administration API", + "version" : "2.0", + "x-xgen-sha" : "63cbfec3f6eeceb446c1d2641263b0628f04f450" + }, + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "tags" : [ { + "description" : "Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.", + "name" : "Access Tracking" + }, { + "description" : "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.", + "name" : "Alert Configurations" + }, { + "description" : "Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.", + "name" : "Alerts" + }, { + "description" : "Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.", + "name" : "Atlas Search" + }, { + "description" : "Returns and edits database auditing settings for MongoDB Cloud projects.", + "name" : "Auditing" + }, { + "description" : "Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.", + "name" : "AWS Clusters DNS" + }, { + "description" : "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.", + "name" : "Cloud Backups" + }, { + "description" : "Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.", + "name" : "Cloud Migration Service" + }, { + "description" : "Returns, adds, authorizes, and removes AWS IAM roles in Atlas.", + "name" : "Cloud Provider Access" + }, { + "description" : "Returns, starts, or ends a cluster outage simulation.", + "name" : "Cluster Outage Simulation" + }, { + "description" : "Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.", + "name" : "Clusters" + }, { + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.", + "name" : "Collection Level Metrics" + }, { + "description" : "Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.", + "name" : "Custom Database Roles" + }, { + "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", + "name" : "Data Federation" + }, { + "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "name" : "Data Lake Pipelines" + }, { + "description" : "Returns, adds, edits, and removes database users.", + "name" : "Database Users" + }, { + "description" : "Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "name" : "Encryption at Rest using Customer Key Management" + }, { + "description" : "Returns events. This collection remains under revision and may change.", + "name" : "Events" + }, { + "description" : "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.", + "name" : "Federated Authentication" + }, { + "description" : "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.\nMongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.", + "name" : "Global Clusters" + }, { + "description" : "Returns invoices.", + "name" : "Invoices" + }, { + "description" : "Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.", + "name" : "LDAP Configuration" + }, { + "description" : "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.", + "name" : "Legacy Backup" + }, { + "description" : "Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.", + "name" : "Maintenance Windows" + }, { + "description" : "Returns, adds, and edits MongoDB Cloud users.", + "name" : "MongoDB Cloud Users" + }, { + "description" : "Returns database deployment monitoring and logging data.", + "name" : "Monitoring and Logs" + }, { + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.", + "name" : "Network Peering" + }, { + "description" : "Returns, adds, edits, or removes an online archive.", + "name" : "Online Archive" + }, { + "description" : "Returns, adds, and edits organizational units in MongoDB Cloud.", + "name" : "Organizations" + }, { + "description" : "Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.", + "name" : "Performance Advisor" + }, { + "description" : "Returns, adds, edits, and removes private endpoint services.", + "name" : "Private Endpoint Services" + }, { + "description" : "Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.", + "name" : "Programmatic API Keys" + }, { + "description" : "Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.", + "name" : "Project IP Access List" + }, { + "description" : "Returns, adds, and edits collections of clusters and users in MongoDB Cloud.", + "name" : "Projects" + }, { + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", + "name" : "Push-Based Log Export" + }, { + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", + "name" : "Rolling Index" + }, { + "description" : "Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.", + "name" : "Root" + }, { + "description" : "Returns, adds, edits, and removes serverless instances.", + "name" : "Serverless Instances" + }, { + "description" : "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "name" : "Serverless Private Endpoints" + }, { + "description" : "Returns and adds restore jobs for shared-tier database deployments.", + "name" : "Shared-Tier Restore Jobs" + }, { + "description" : "Returns and requests to download shared-tier database deployment snapshots.", + "name" : "Shared-Tier Snapshots" + }, { + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.", + "name" : "Streams" + }, { + "description" : "Returns, adds, edits, or removes teams.", + "name" : "Teams" + }, { + "description" : "Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.\n\n**IMPORTANT**: Each project can only have one configuration per integrationType.", + "name" : "Third-Party Integrations" + }, { + "description" : "Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.", + "externalDocs" : { + "description" : "Self-Managed X.509 Certificates", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/" + }, + "name" : "X.509 Authentication" + } ], + "paths" : { + "/api/atlas/v2" : { + "get" : { + "description" : "This resource returns information about the MongoDB application along with API key meta data.", + "operationId" : "getSystemStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized." + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the status of this MongoDB application", + "tags" : [ "Root" ] + } + }, + "/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.", + "operationId" : "listAlertConfigurationMatchersFieldNames", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get All Alert Configuration Matchers Field Names", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "operationId" : "listClustersForAllProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Authorized Clusters in All Projects", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/eventTypes" : { + "get" : { + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "List All Possible Event Types", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "deleteFederationApp", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Federation Settings Instance", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connected Org Configs from One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "description" : "The connected organization configuration that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listRoleMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Role Mappings from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Role Mapping to One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "deleteRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Role Mapping in One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listIdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "The protocols of the target identity providers.", + "in" : "query", + "name" : "protocol", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "description" : "The types of the target identity providers.", + "in" : "query", + "name" : "idpType", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + } + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Identity Providers in One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: This resource only supports the creation of OIDC identity providers.", + "operationId" : "createIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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/).", + "operationId" : "deleteIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Identity Provider", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. Deprecated versions: v2-{2023-01-01}", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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).", + "operationId" : "revokeJwksFromIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke the JWKS from One OIDC Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Adds one MongoDB Cloud user to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "204" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One MongoDB Cloud User to One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "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.\n\nThis resource remains under revision and may change. Deprecated versions: v2-{2023-01-01}", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/AcknowledgeAlert" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/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}", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketsView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592" + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ], + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ], + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + } + }, + "/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}", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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-01-01}", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAdvancedClusterDescriptionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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-01-01}", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getPinnedNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve pinned namespaces for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pin Namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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", + "operationId" : "unpinNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to unpin namespaces from.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unpin namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "description" : "Returns 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 Read Only role. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ] + } + }, + "/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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + }, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ] + }, + "get" : { + "description" : "Return the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ] + }, + "patch" : { + "description" : "Updates the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ] + }, + "post" : { + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + } + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Service Unavailable." + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Cluster", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + } + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Service Unavailable." + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the Atlas Search index to delete.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index by Name", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the Atlas Search index to return.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index by Name", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index you want to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the Atlas Search index to update.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexUpdateRequest" + } + } + }, + "description" : "Details to update the Atlas Search index with.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index By Name", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index by Id", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Service Unavailable." + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index by ID", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index you want to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexUpdateRequest" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index By ID", + "tags" : [ "Atlas Search" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Cluster", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceClusterMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve metrics for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "explode" : true, + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given cluster", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyCluster" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Cluster-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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}", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all metric names", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. Deprecated versions: v2-{2023-01-01}", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest20240530" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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}", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest20240530" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForHost", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Host", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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", + "operationId" : "getCollStatsLatencyNamespaceHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given process", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + } + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyHost" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Host-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to create one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "createStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessor" + } + } + }, + "description" : "Details to create an Atlas Streams Processor.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessor" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "deleteStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Processor", + "tags" : [ "Streams" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "startStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "stopStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Stop One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamProcessors", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsStreamProcessorWithStatsView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Stream Processors In The Stream Instance.", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "migrateProjectToAnotherOrg", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMigrationRequest" + } + } + }, + "description" : "Migrates a project from its current organization to another organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Project to Another Organization", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/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).", + "operationId" : "returnAllControlPlaneIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/ControlPlaneIPAddresses" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "summary" : "Return All Control Plane IP Addresses", + "tags" : [ "Root" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20250101" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20250101", + "AZURE" : "#/components/schemas/AzureRegionConfig20250101", + "GCP" : "#/components/schemas/GCPRegionConfig20250101", + "TENANT" : "#/components/schemas/TenantRegionConfig20250101" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20250101" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20250101" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20250101" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20250101" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20250101" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20250101" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20250101" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20250101" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20250101" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20250101" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20250101" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20250101" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20250101" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20250101" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20250101" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20250101" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20250101" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data." + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "string", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20250101" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20250101" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20250101" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/exemptions.yaml b/tools/cli/test/data/changelog/new-version/exemptions.yaml new file mode 100644 index 000000000..e20842647 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/exemptions.yaml @@ -0,0 +1,3424 @@ +# Breaking changes exemptions definition: +# +# breaking_change_description: A sum of the data described in breaking_changes_raw.diff ({operation} {path} {text} [{id}]) +# exempt_until: The date until when the breaking change can be detected. Usually targeted at the mms next release +# reason: The reason for the exemption (e.g. spec correction, false positive) +# For more info check https://wiki.corp.mongodb.com/x/rh9LCw#AtlasAdminAPIBreakingChanges-Requestexemption + +- "breaking_change_description": "API GET /api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders removed the enum value 'OIDC' from the 'query' request parameter 'protocol' [request-parameter-enum-value-removed]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API GET /api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders removed the enum value 'SAML' from the 'query' request parameter 'protocol' [request-parameter-enum-value-removed]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API GET /api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders removed the enum value 'WORKFORCE' from the 'query' request parameter 'idpType' [request-parameter-enum-value-removed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API GET /api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders removed the enum value 'WORKLOAD' from the 'query' request parameter 'idpType' [request-parameter-enum-value-removed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the enum value 'OIDC' from the 'query' request parameter 'protocol' [request-parameter-enum-value-removed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the enum value 'SAML' from the 'query' request parameter 'protocol' [request-parameter-enum-value-removed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the enum value 'WORKFORCE' from the 'query' request parameter 'idpType' [request-parameter-enum-value-removed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the enum value 'WORKLOAD' from the 'query' request parameter 'idpType' [request-parameter-enum-value-removed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders for the 'query' request parameter 'idpType', the type/format was changed from 'string'/'' to 'array'/'' [request-parameter-type-changed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders for the 'query' request parameter 'protocol', the type/format was changed from 'string'/'' to 'array'/'' [request-parameter-type-changed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment the request property 'specs' became required [request-property-became-required]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment the 'specs' request property's minItems was increased to '1' [request-property-min-items-increased]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment the request property 'specs' became required [request-property-became-required]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment the 'specs' request property's minItems was increased to '1' [request-property-min-items-increased]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'PaginatedApiUserAccessListView' [api-schema-removed]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "removed the schema 'UserAccessList' [api-schema-removed]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList changed the pattern of the request property '/items/cidrBlock' from '^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$' to '^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$' [request-property-pattern-changed]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList changed the pattern of the request property '/items/ipAddress' from '^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$' to '^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$' [request-property-pattern-changed]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0 removed the non-success response with the status '404' [response-non-success-status-removed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2 removed the non-success response with the status '404' [response-non-success-status-removed]." + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2 removed the media type 'application/json' for the response with the status '401' [response-media-type-removed]" + "exempt_until": "2024-03-06" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces for the 'query' request parameter 'since', the min was increased from '1199145600.00' to '1199145600000.00' [request-parameter-min-increased]" + "exempt_until": "2024-03-06" + "reason": "Doc correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs for the 'query' request parameter 'since', the min was increased from '1199145600.00' to '1199145600000.00' [request-parameter-min-increased]" + "exempt_until": "2024-03-06" + "reason": "Doc correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes for the 'query' request parameter 'since', the min was set to '1199145600000.00' [request-parameter-min-set]" + "exempt_until": "2024-03-06" + "reason": "Doc correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces for the 'query' request parameter 'since', the min was increased from '1199145600.00' to '1199145600000.00' [request-parameter-min-increased]" + "exempt_until": "2024-03-06" + "reason": "Doc correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs for the 'query' request parameter 'since', the min was increased from '1199145600.00' to '1199145600000.00' [request-parameter-min-increased]" + "exempt_until": "2024-03-06" + "reason": "Doc correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes for the 'query' request parameter 'since', the min was set to '1199145600000.00' [request-parameter-min-set]" + "exempt_until": "2024-03-06" + "reason": "Doc correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'GroupName' [api-schema-removed]" + "exempt_until": "2024-03-06" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/provider/regions removed the 'GSP' enum value from the 'results/items/provider' response property for the response status '200' [response-property-enum-value-removed]." + "exempt_until": "2024-03-27" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters/provider/regions removed the 'GSP' enum value from the 'results/items/provider' response property for the response status '200' [response-property-enum-value-removed]." + "exempt_until": "2024-03-27" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'PaginatedServiceAccountIPAccessEntryView' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountIPAccessListEntry' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts api operation id 'createServiceAccount' removed and replaced with 'createProjectServiceAccount' [api-operation-id-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} api operation id 'updateServiceAccount' removed and replaced with 'updateProjectServiceAccount' [api-operation-id-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts api operation id 'createServiceAccount_1' removed and replaced with 'createServiceAccount' [api-operation-id-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} api operation id 'updateServiceAccount_1' removed and replaced with 'updateServiceAccount' [api-operation-id-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/accessList api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/accessList api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/accessList/{ipAddress} api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountGroupAccessRole' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountGroupDetails' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountGroupRequest' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountGroupRoleAssignment' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountGroupUpdateRequest' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'PaginatedServiceAccounts' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccount' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountDetails' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts the response's property type/format changed from 'object'/'' to 'array'/'' for status '201' [response-property-type-changed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the optional property 'results/items/roles' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the request property 'roles' [request-property-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the optional property 'roleNames/groups' from the response with the '201' status [response-optional-property-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the optional property 'roleNames/org' from the response with the '201' status [response-optional-property-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} removed the optional property 'roles' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} removed the request property 'roles' [request-property-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} removed the optional property 'roles' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'GroupServiceAccountAccessRole' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountAccessRole' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountRequest' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountUpdateRequest' [api-schema-removed]" + "exempt_until": "2024-03-27" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups removed the 'NONE' enum value from the 'results/items/regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "POST /api/atlas/v1.0/groups removed the enum value 'NONE' of the request property 'regionUsageRestrictions' [request-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Request value does not apply to Atlas for Government and is unavailable in Commercial" +- "breaking_change_description": "POST /api/atlas/v1.0/groups removed the 'NONE' enum value from the 'regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/byName/{groupName} removed the 'NONE' enum value from the 'regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId} removed the 'NONE' enum value from the 'regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId} removed the 'NONE' enum value from the 'regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "GET /api/atlas/v1.0/orgs/{orgId}/groups removed the 'NONE' enum value from the 'results/items/regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "GET /api/atlas/v2/groups removed the 'NONE' enum value from the 'results/items/regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "POST /api/atlas/v2/groups removed the enum value 'NONE' of the request property 'regionUsageRestrictions' [request-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Request value does not apply to Atlas for Government and is unavailable in Commercial" +- "breaking_change_description": "POST /api/atlas/v2/groups removed the 'NONE' enum value from the 'regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "GET /api/atlas/v2/groups/byName/{groupName} removed the 'NONE' enum value from the 'regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId} removed the 'NONE' enum value from the 'regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId} removed the 'NONE' enum value from the 'regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/groups removed the 'NONE' enum value from the 'results/items/regionUsageRestrictions' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-04-17" + "reason": "Correction. Value was never available in responses" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs removed 'BaseSchema[1]:Cps Backup Event Types' from the '/oneOf[#/components/schemas/DefaultAlertConfigViewForNdsGroup]/eventTypeName' request property 'oneOf' list [request-property-one-of-removed]" + "exempt_until": "2024-04-30" + "reason": "Fix false positive" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed 'BaseSchema[1]:Cps Backup Event Types' from the '/oneOf[#/components/schemas/DefaultAlertConfigViewForNdsGroup]/eventTypeName' request property 'oneOf' list [request-property-one-of-removed]" + "exempt_until": "2024-04-30" + "reason": "Fix false positive" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed 'BaseSchema[1]:Cps Backup Event Types' from the '/oneOf[#/components/schemas/DefaultAlertViewForNdsGroup]/eventTypeName' request property 'oneOf' list [request-property-one-of-removed]" + "exempt_until": "2024-04-30" + "reason": "Fix false positive" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives removed the optional property 'results/items/dataProcessRegion/region' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives added the new 'AZURE' enum value to the 'results/items/dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives removed the request property 'dataProcessRegion/region' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives removed the optional property 'dataProcessRegion/region' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives added the new 'AZURE' enum value to the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} removed the optional property 'dataProcessRegion/region' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} added the new 'AZURE' enum value to the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} removed the optional property 'dataProcessRegion/region' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId} added the new 'AZURE' enum value to the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "API POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs api tag 'Legacy Backup Restore Jobs' removed [api-tag-removed]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API POST /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/restoreJobs api tag 'Legacy Backup Restore Jobs' removed [api-tag-removed]" + "exempt_until": "2024-04-17" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API POST /api/atlas/v2/groups/{groupId}/clusters removed the request property 'selfManagedSharding' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Accidental documentation. Field will be enabled via feature flag" + "hide_from_changelog": "true" +- "breaking_change_description": "API POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the request property 'selfManagedSharding' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Accidental documentation. Field will be enabled via feature flag" + "hide_from_changelog": "true" +- "breaking_change_description": "API PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the request property 'selfManagedSharding' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Accidental documentation. Field will be enabled via feature flag" + "hide_from_changelog": "true" +- "breaking_change_description": "API PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the request property 'selfManagedSharding' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Accidental documentation. Field will be enabled via feature flag" + "hide_from_changelog": "true" +- "breaking_change_description": "API POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the request property 'selfManagedSharding' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Accidental documentation. Field will be enabled via feature flag" + "hide_from_changelog": "true" +- "breaking_change_description": "API PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the request property 'selfManagedSharding' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Accidental documentation. Field will be enabled via feature flag" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the optional property 'results/items/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProvider]/audienceClaim' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the optional property 'results/items/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProvider]/audienceClaim' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the request property '/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate]/audienceClaim' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the request property '/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate]/audienceClaim' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the request property 'audienceClaim' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the optional property '/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProvider]/audienceClaim' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the optional property '/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProvider]/audienceClaim' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders removed the optional property 'audienceClaim' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} removed the optional property '/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProvider]/audienceClaim' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} removed the optional property '/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProvider]/audienceClaim' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} removed the request property '/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate]/audienceClaim' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} removed the request property '/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate]/audienceClaim' [request-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} removed the optional property '/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProvider]/audienceClaim' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} removed the optional property '/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProvider]/audienceClaim' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-04-17" + "reason": "Remove deprecated field" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/pushBasedLogExport the request property 'bucketName' became required [request-property-became-required]" + "exempt_until": "2024-05-08" + "reason": "POST fields had validation to ensure required but Schema did not reflect that." + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/pushBasedLogExport the request property 'iamRoleId' became required [request-property-became-required]" + "exempt_until": "2024-05-08" + "reason": "POST fields had validation to ensure required but Schema did not reflect that." + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/pushBasedLogExport the request property 'prefixPath' became required [request-property-became-required]" + "exempt_until": "2024-05-08" + "reason": "POST fields had validation to ensure required but Schema did not reflect that." + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts removed the optional property 'results/items/roleNames' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the request property 'roleNames' [request-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the optional property 'roleNames' from the response with the '201' status [response-optional-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the optional property 'roleNames' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the request property 'roleNames' [request-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the optional property 'roleNames' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the request property '/items/roleNames' [request-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the optional property 'results/items/roleNames' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the request property 'roleNames' [request-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the optional property 'roleNames' from the response with the '201' status [response-optional-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} removed the optional property 'roleNames' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} removed the request property 'roleNames' [request-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} removed the optional property 'roleNames' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations the response property 'results/items/id' became nullable for the status '200' [response-property-became-nullable]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'DATADOG' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'HIP_CHAT' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'MICROSOFT_TEAMS' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'NEW_RELIC' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'OPS_GENIE' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'PAGER_DUTY' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'PROMETHEUS' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'SLACK' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'VICTOR_OPS' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations removed the 'WEBHOOK' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} the response property 'id' became nullable for the status '200' [response-property-became-nullable]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'DATADOG' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'HIP_CHAT' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'MICROSOFT_TEAMS' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'NEW_RELIC' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'OPS_GENIE' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'PAGER_DUTY' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'PROMETHEUS' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'SLACK' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'VICTOR_OPS' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'WEBHOOK' enum value from the 'id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'DATADOG' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'HIP_CHAT' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'MICROSOFT_TEAMS' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'NEW_RELIC' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'OPS_GENIE' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'PAGER_DUTY' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'PROMETHEUS' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'SLACK' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'VICTOR_OPS' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'WEBHOOK' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} the response property 'results/items/id' became nullable for the status '200' [response-property-became-nullable]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'DATADOG' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'HIP_CHAT' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'MICROSOFT_TEAMS' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'NEW_RELIC' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'OPS_GENIE' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'PAGER_DUTY' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'PROMETHEUS' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'SLACK' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'VICTOR_OPS' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'WEBHOOK' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'DATADOG' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'HIP_CHAT' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'MICROSOFT_TEAMS' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'NEW_RELIC' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'OPS_GENIE' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'PAGER_DUTY' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'PROMETHEUS' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'SLACK' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'VICTOR_OPS' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the enum value 'WEBHOOK' of the request property 'id' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} the response property 'results/items/id' became nullable for the status '200' [response-property-became-nullable]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'DATADOG' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'HIP_CHAT' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'MICROSOFT_TEAMS' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'NEW_RELIC' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'OPS_GENIE' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'PAGER_DUTY' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'PROMETHEUS' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'SLACK' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'VICTOR_OPS' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/integrations/{integrationType} removed the 'WEBHOOK' enum value from the 'results/items/id' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ApiStreamsAzureRegionView' [api-schema-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams removed the 'DUBLIN_IRL' enum value from the 'results/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams removed the 'FRANKFURT_DEU' enum value from the 'results/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams removed the 'LONDON_GBR' enum value from the 'results/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams removed the 'MUMBAI_IND' enum value from the 'results/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams removed the 'OREGON_USA' enum value from the 'results/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams removed the 'SAOPAULO_BRA' enum value from the 'results/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams removed the 'SINGAPORE_SGP' enum value from the 'results/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams removed the 'SYDNEY_AUS' enum value from the 'results/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the enum value 'DUBLIN_IRL' of the request property 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the enum value 'FRANKFURT_DEU' of the request property 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the enum value 'LONDON_GBR' of the request property 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the enum value 'MUMBAI_IND' of the request property 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the enum value 'OREGON_USA' of the request property 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the enum value 'SAOPAULO_BRA' of the request property 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the enum value 'SINGAPORE_SGP' of the request property 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the enum value 'SYDNEY_AUS' of the request property 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed 'ApiStreamsAzureRegionView' from the 'dataProcessRegion/region' request property 'oneOf' list [request-property-one-of-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the 'DUBLIN_IRL' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the 'FRANKFURT_DEU' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the 'LONDON_GBR' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the 'MUMBAI_IND' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the 'OREGON_USA' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the 'SAOPAULO_BRA' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the 'SINGAPORE_SGP' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams removed the 'SYDNEY_AUS' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'DUBLIN_IRL' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'FRANKFURT_DEU' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'LONDON_GBR' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'MUMBAI_IND' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'OREGON_USA' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'SAOPAULO_BRA' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'SINGAPORE_SGP' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'SYDNEY_AUS' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the enum value 'DUBLIN_IRL' of the request property 'region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the enum value 'FRANKFURT_DEU' of the request property 'region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the enum value 'LONDON_GBR' of the request property 'region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the enum value 'MUMBAI_IND' of the request property 'region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the enum value 'OREGON_USA' of the request property 'region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the enum value 'SAOPAULO_BRA' of the request property 'region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the enum value 'SINGAPORE_SGP' of the request property 'region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the enum value 'SYDNEY_AUS' of the request property 'region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed 'ApiStreamsAzureRegionView' from the 'region' request property 'oneOf' list [request-property-one-of-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'DUBLIN_IRL' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'FRANKFURT_DEU' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'LONDON_GBR' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'MUMBAI_IND' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'OREGON_USA' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'SAOPAULO_BRA' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'SINGAPORE_SGP' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/streams/{tenantName} removed the 'SYDNEY_AUS' enum value from the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiStreamsAWSRegionView]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec Correction" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/invoices the 'results/items/payments/items/unitPrice' response's property type/format changed from 'number'/'double' to 'string'/'' for status '200' [response-property-type-changed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/invoices/pending the 'results/items/payments/items/unitPrice' response's property type/format changed from 'number'/'double' to 'string'/'' for status '200' [response-property-type-changed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId} the 'payments/items/unitPrice' response's property type/format changed from 'number'/'double' to 'string'/'' for status '200' [response-property-type-changed]" + "exempt_until": "2024-05-08" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs the response property '/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId} the response property 'identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId} the response property 'identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders the response property 'results/items/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders the response property 'results/items/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders the response property 'results/items/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders the response property 'results/items/oneOf[#/components/schemas/FederationSamlIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders the response property '/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders the response property '/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders the response property 'associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} the response property '/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} the response property '/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} the response property '/oneOf[#/components/schemas/FederationSamlIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} the response property 'associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} the response property '/oneOf[#/components/schemas/FederationOidcWorkforceIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} the response property '/oneOf[#/components/schemas/FederationOidcWorkloadIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} the response property '/oneOf[#/components/schemas/FederationSamlIdentityProvider]/associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} the response property 'associatedOrgs/items/identityProviderId' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts added the new required request property 'secretExpiresAfterHours' [new-required-request-property]" + "exempt_until": "2024-05-08" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts added the new required request property 'secretExpiresAfterHours' [new-required-request-property]" + "exempt_until": "2024-05-08" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the request property 'secretExpiresAt' [request-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the request property 'secretExpiresAt' [request-property-removed]" + "exempt_until": "2024-05-08" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs the response's body type/format changed from 'array'/'' to 'object'/'' for status '200' [response-body-type-changed]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets removed the 'GCP' enum value from the 'results/items/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]." + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets removed the enum value 'GCP' of the request property 'cloudProvider' [request-property-enum-value-removed]." + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets removed the 'GCP' enum value from the 'cloudProvider' response property for the response status '200' [response-property-enum-value-removed]." + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets/{exportBucketId} removed the 'GCP' enum value from the 'cloudProvider' response property for the response status '200' [response-property-enum-value-removed]." + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets removed the 'GCP' enum value from the 'results/items/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]." + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/backup/exportBuckets removed the 'GCP' enum value from the 'results/items/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]." + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets removed the enum value 'GCP' of the request property 'cloudProvider' [request-property-enum-value-removed]." + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets removed the 'GCP' enum value from the 'cloudProvider' response property for the response status '200' [response-property-enum-value-removed]." + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} removed the 'GCP' enum value from the 'cloudProvider' response property for the response status '200' [response-property-enum-value-removed]." + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'UserGroupEvent' [api-schema-removed]" + "exempt_until": "2024-06-01" + "reason": "In development. Event scope change for Private Preview." + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'UserGroupEventTypeView' [api-schema-removed]" + "exempt_until": "2024-06-01" + "reason": "In development. Event scope change for Private Preview." + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'linearizable' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'majority' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'snapshot' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the enum value 'linearizable' of the request property 'defaultReadConcern'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the enum value 'majority' of the request property 'defaultReadConcern'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the enum value 'snapshot' of the request property 'defaultReadConcern'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'linearizable' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'majority' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'snapshot' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'linearizable' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'majority' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'snapshot' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs removed the enum value 'linearizable' of the request property 'defaultReadConcern'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs removed the enum value 'majority' of the request property 'defaultReadConcern'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs removed the enum value 'snapshot' of the request property 'defaultReadConcern'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'linearizable' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'majority' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs removed the 'snapshot' enum value from the 'defaultReadConcern' response property for the response status '200'" + "exempt_until": "2024-06-01" + "reason": "Invalid value" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} added the new required request property 'acknowledgedUntil' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed '#/components/schemas/AppServiceAlertView, #/components/schemas/ClusterAlertView, #/components/schemas/HostAlertViewForNdsGroup, #/components/schemas/HostMetricAlert, #/components/schemas/ReplicaSetAlertViewForNdsGroup, #/components/schemas/StreamProcessorAlertViewForNdsGroup, #/components/schemas/DefaultAlertViewForNdsGroup' from the request body 'oneOf' list [request-body-one-of-removed]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'ACTIVATED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'ALL_USERS_HAVE_MULTIFACTOR_AUTH' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'CHARTS_ACTIVATED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'CHARTS_ACTIVATION_REQUESTED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'CHARTS_RESET' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'CHARTS_UPGRADED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'FLUSHED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'HOST_DISK_SPACE_SUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the 'results/items/oneOf[subschema #12: Host Events]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'LOCKED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'MAINTENANCE_AUTO_DEFER_DISABLED' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'MAINTENANCE_AUTO_DEFER_ENABLED' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'MAINTENANCE_DEFERRED' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'MAINTENANCE_START_ASAP' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'MAINTENANCE_WINDOW_ADDED' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'MAINTENANCE_WINDOW_MODIFIED' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'MAINTENANCE_WINDOW_REMOVED' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'OS_MAINTENANCE_CERTIFICATE_ROTATION_RESTART' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'OS_TUNED_FILE_OVERRIDES' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'SET_CHEF_TARBALL_URI' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'SET_IMAGE_OVERRIDES' enum value from the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'SUSPENDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'TEMPORARILY_ACTIVATED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'ACTIVATED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'ALL_USERS_HAVE_MULTIFACTOR_AUTH' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'CHARTS_ACTIVATED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'CHARTS_ACTIVATION_REQUESTED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'CHARTS_RESET' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'CHARTS_UPGRADED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'FLUSHED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'HOST_DISK_SPACE_SUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #12: Host Events]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'LOCKED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'MAINTENANCE_AUTO_DEFER_DISABLED' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'MAINTENANCE_AUTO_DEFER_ENABLED' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'MAINTENANCE_DEFERRED' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'MAINTENANCE_START_ASAP' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'MAINTENANCE_WINDOW_ADDED' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'MAINTENANCE_WINDOW_MODIFIED' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'MAINTENANCE_WINDOW_REMOVED' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'OS_MAINTENANCE_CERTIFICATE_ROTATION_RESTART' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'OS_TUNED_FILE_OVERRIDES' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'SET_CHEF_TARBALL_URI' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'SET_IMAGE_OVERRIDES' enum value from the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'SUSPENDED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'TEMPORARILY_ACTIVATED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #11: Group Audit Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/events removed the 'CREDIT_SFOLI_MODIFIED' enum value from the 'results/items/oneOf[subschema #6: Billing Events]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/events removed the 'ORG_DISCONNECTED_FROM_VERCEL' enum value from the 'results/items/oneOf[subschema #8: Org Events]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/events/{eventId} removed the 'CREDIT_SFOLI_MODIFIED' enum value from the '/oneOf[subschema #6: Billing Events]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/events/{eventId} removed the 'ORG_DISCONNECTED_FROM_VERCEL' enum value from the '/oneOf[subschema #8: Org Events]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Remove duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #10: NDS X509 User Authentication Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #10: NDS X509 User Authentication Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #10: NDS X509 User Authentication Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #13: Serverless Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #13: Serverless Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #13: Serverless Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #1: Any Other Alert Configurations]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #1: Any Other Alert Configurations]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #1: Any Other Alert Configurations]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #4: Billing Threshold Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #4: Billing Threshold Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #4: Billing Threshold Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #6: Cps Backup Threshold Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #6: Cps Backup Threshold Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #6: Cps Backup Threshold Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #7: Encryption Key Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #7: Encryption Key Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs added the new required request property '/oneOf[subschema #7: Encryption Key Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #10: NDS X509 User Authentication Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #10: NDS X509 User Authentication Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #10: NDS X509 User Authentication Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #13: Serverless Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #13: Serverless Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #13: Serverless Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #1: Any Other Alert Configurations]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #1: Any Other Alert Configurations]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #1: Any Other Alert Configurations]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #4: Billing Threshold Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #4: Billing Threshold Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #4: Billing Threshold Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #6: Cps Backup Threshold Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #6: Cps Backup Threshold Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #6: Cps Backup Threshold Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #7: Encryption Key Alert Configuration]/matchers/items/fieldName' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #7: Encryption Key Alert Configuration]/matchers/items/operator' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} added the new required request property '/oneOf[subschema #7: Encryption Key Alert Configuration]/matchers/items/value' [new-required-request-property]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes api operation id 'createAtlasSearchIndex' removed and replaced with 'createAtlasSearchIndexDeprecated' [api-operation-id-removed]" + "exempt_until": "2024-05-30" + "reason": "renaming deprecated and moved operations" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName} api operation id 'listAtlasSearchIndexes' removed and replaced with 'listAtlasSearchIndexesDeprecated' [api-operation-id-removed]" + "exempt_until": "2024-05-30" + "reason": "renaming deprecated and moved operations" + "hide_from_changelog": "false" +- "breaking_change_description": "DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} api operation id 'deleteAtlasSearchIndex' removed and replaced with 'deleteAtlasSearchIndexDeprecated' [api-operation-id-removed]" + "exempt_until": "2024-05-30" + "reason": "renaming deprecated and moved operations" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} api operation id 'getAtlasSearchIndex' removed and replaced with 'getAtlasSearchIndexDeprecated' [api-operation-id-removed]" + "exempt_until": "2024-05-30" + "reason": "renaming deprecated and moved operations" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId} api operation id 'updateAtlasSearchIndex' removed and replaced with 'updateAtlasSearchIndexDeprecated' [api-operation-id-removed]" + "exempt_until": "2024-05-30" + "reason": "renaming deprecated and moved operations" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the 'results/items/oneOf[subschema #8: Host Alert Configuration]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs removed the enum value 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' of the request property '/oneOf[subschema #8: Host Alert Configuration]/eventTypeName' [request-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs removed the enum value 'USERS_WITHOUT_MULTIFACTOR_AUTH' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #8: Host Alert Configuration]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #8: Host Alert Configuration]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #8: Host Alert Configuration]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the enum value 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' of the request property '/oneOf[subschema #8: Host Alert Configuration]/eventTypeName' [request-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the enum value 'USERS_WITHOUT_MULTIFACTOR_AUTH' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' [request-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #8: Host Alert Configuration]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the 'results/items/oneOf[subschema #3: Host Alerts]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the 'results/items/oneOf[subschema #6: Stream Processor Alerts]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the 'results/items/oneOf[subschema #3: Host Alerts]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the 'results/items/oneOf[subschema #6: Stream Processor Alerts]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #3: Host Alerts]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #6: Stream Processor Alerts]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #3: Host Alerts]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #6: Stream Processor Alerts]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the 'results/items/oneOf[subschema #8: Host Alert Configuration]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the 'results/items/oneOf[subschema #12: Host Events]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'HOST_DISK_SPACE_INSUFFICIENT_FOR_SEARCH_INDEX_REBUILD' enum value from the '/oneOf[subschema #12: Host Events]/eventTypeName' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'USERS_WITHOUT_MULTIFACTOR_AUTH' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-05-30" + "reason": "Removed duplicate enums" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId} api path removed without deprecation [api-path-removed-without-deprecation]" + "exempt_until": "2024-06-01" +- "breaking_change_description": "removed the schema 'DiskBackupBaseRestoreMember' [api-schema-removed]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts the response property 'results/items/oneOf[subschema #1: App Services Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts the response property 'results/items/oneOf[subschema #2: Cluster Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts the response property 'results/items/oneOf[subschema #3: Host Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts the response property 'results/items/oneOf[subschema #4: Host Metric Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts the response property 'results/items/oneOf[subschema #5: ReplicaSet Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts the response property 'results/items/oneOf[subschema #6: Stream Processor Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts the response property 'results/items/oneOf[subschema #7: Any Other Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts the response property 'results/items/oneOf[subschema #1: App Services Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts the response property 'results/items/oneOf[subschema #2: Cluster Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts the response property 'results/items/oneOf[subschema #3: Host Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts the response property 'results/items/oneOf[subschema #4: Host Metric Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts the response property 'results/items/oneOf[subschema #5: ReplicaSet Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts the response property 'results/items/oneOf[subschema #6: Stream Processor Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts the response property 'results/items/oneOf[subschema #7: Any Other Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #1: App Services Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #2: Cluster Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #3: Host Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #4: Host Metric Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #5: ReplicaSet Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #6: Stream Processor Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #7: Any Other Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #1: App Services Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #2: Cluster Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #3: Host Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #4: Host Metric Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #5: ReplicaSet Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #6: Stream Processor Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} the response property '/oneOf[subschema #7: Any Other Alerts]/acknowledgedUntil' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-05-30" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts the 'description' request property's minLength was increased from '0' to '1' [request-property-min-length-increased]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts the 'name' request property's minLength was increased from '0' to '1' [request-property-min-length-increased]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} the 'description' request property's minLength was increased from '0' to '1' [request-property-min-length-increased]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} the 'name' request property's minLength was increased from '0' to '1' [request-property-min-length-increased]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts the 'description' request property's minLength was increased from '0' to '1' [request-property-min-length-increased]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts the 'name' request property's minLength was increased from '0' to '1' [request-property-min-length-increased]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} the 'description' request property's minLength was increased from '0' to '1' [request-property-min-length-increased]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} the 'name' request property's minLength was increased from '0' to '1' [request-property-min-length-increased]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts the 'description' request property's maxLength was set to '250' [request-property-max-length-set]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts the 'name' request property's maxLength was set to '64' [request-property-max-length-set]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} the 'description' request property's maxLength was set to '250' [request-property-max-length-set]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} the 'name' request property's maxLength was set to '64' [request-property-max-length-set]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts the 'description' request property's maxLength was set to '250' [request-property-max-length-set]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts the 'name' request property's maxLength was set to '64' [request-property-max-length-set]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} the 'description' request property's maxLength was set to '250' [request-property-max-length-set]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} the 'name' request property's maxLength was set to '64' [request-property-max-length-set]" + "exempt_until": "2024-06-24" + "reason": "Spec correction" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters removed the '4.2' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters removed the '4.4' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters removed the '5.0' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters removed the '6.0' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters removed the '7.0' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the enum value '4.2' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the enum value '4.4' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the enum value '5.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the enum value '6.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the enum value '7.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the enum value '4.2' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the enum value '4.4' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the enum value '5.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the enum value '6.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the enum value '7.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/clusters/tenantUpgrade removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the enum value '4.2' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the enum value '4.4' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the enum value '5.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the enum value '6.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the enum value '7.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName} removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters removed the '4.2' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters removed the '4.4' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters removed the '5.0' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters removed the '6.0' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters removed the '7.0' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the enum value '4.2' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the enum value '4.4' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the enum value '5.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the enum value '6.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the enum value '7.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.5/groups/{groupId}/clusters removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the enum value '4.2' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the enum value '4.4' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the enum value '5.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the enum value '6.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the enum value '7.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v1.5/groups/{groupId}/clusters/{clusterName} removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters removed the '4.2' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters removed the '4.4' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters removed the '5.0' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters removed the '6.0' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters removed the '7.0' enum value from the 'results/items/mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the enum value '4.2' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the enum value '4.4' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the enum value '5.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the enum value '6.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the enum value '7.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the enum value '4.2' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the enum value '4.4' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the enum value '5.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the enum value '6.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the enum value '7.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the enum value '4.2' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the enum value '4.4' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the enum value '5.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the enum value '6.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the enum value '7.0' of the request property 'mongoDBMajorVersion' [request-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '4.2' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '4.4' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '5.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '6.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} removed the '7.0' enum value from the 'mongoDBMajorVersion' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-06-20" + "reason": "CLOUDP-199300" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the request property 'defaultReadConcern' [request-property-removed]" + "exempt_until": "2024-07-10" + "reason": "Exemption for cloud-dev only, generated as a result of un-hiding the new version in cloud-dev" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs removed the request property 'failIndexKeyTooLong' [request-property-removed]" + "exempt_until": "2024-07-10" + "reason": "Exemption for cloud-dev only, generated as a result of un-hiding the new version in cloud-dev" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters api sunset date deleted, but deprecated=true kept [sunset-deleted]" + "exempt_until": "2024-07-10" + "reason": "Exemption for cloud-dev only, generated as a result of un-hiding the new version in cloud-dev" + "hide_from_changelog": "true" +- "breaking_change_description": "API None None removed the schema 'ApiAtlasClusterDescriptionResource20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Exemption for cloud-dev only, generated as a result of un-hiding the new version in cloud-dev" + "hide_from_changelog": "true" +- "breaking_change_description": "API None None removed the schema 'ClusterDescription20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Exemption for cloud-dev only, generated as a result of un-hiding the new version in cloud-dev" + "hide_from_changelog": "true" +- "breaking_change_description": "API None None removed the schema 'PaginatedClusterDescription20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Exemption for cloud-dev only, generated as a result of un-hiding the new version in cloud-dev" + "hide_from_changelog": "true" +- "breaking_change_description": "API None None removed the schema 'ReplicationSpec20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Exemption for cloud-dev only, generated as a result of un-hiding the new version in cloud-dev" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_ATLAS_ADMIN' enum value from the 'results/items/roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_BILLING_ADMIN' enum value from the 'results/items/roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_CHARTS_ADMIN' enum value from the 'results/items/roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the enum value 'GROUP_ATLAS_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the enum value 'GROUP_BILLING_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the enum value 'GROUP_CHARTS_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_ATLAS_ADMIN' enum value from the 'roles/items/' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_BILLING_ADMIN' enum value from the 'roles/items/' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_CHARTS_ADMIN' enum value from the 'roles/items/' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_ATLAS_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_BILLING_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_CHARTS_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_ATLAS_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_BILLING_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_CHARTS_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_ATLAS_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_BILLING_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_CHARTS_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_ATLAS_ADMIN' of the request property '/items/roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_BILLING_ADMIN' of the request property '/items/roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_CHARTS_ADMIN' of the request property '/items/roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the 'ORG_TEAM_MEMBERS_ADMIN' enum value from the 'results/items/roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the enum value 'ORG_TEAM_MEMBERS_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/orgs/{orgId}/serviceAccounts removed the 'ORG_TEAM_MEMBERS_ADMIN' enum value from the 'roles/items/' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} removed the 'ORG_TEAM_MEMBERS_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} removed the enum value 'ORG_TEAM_MEMBERS_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} removed the 'ORG_TEAM_MEMBERS_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Changes in spec not in production" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'CloudProviderAccessAWSIAMRoleRequest' [api-schema-removed]" + "exempt_until": "2024-07-10" + "reason": "reverting changes introduced in CLOUD-248154 as it caused some of the azure props to missing" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'CloudProviderAccessAWSIAMRoleUpdateRequest' [api-schema-removed]" + "exempt_until": "2024-07-10" + "reason": "reverting changes introduced in CLOUD-248154 as it caused some of the azure props to missing" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId} removed the request property 'iamAssumedRoleArn' [request-property-removed]" + "exempt_until": "2024-07-10" + "reason": "reverting changes introduced in CLOUD-248154 as it caused some of the azure props to missing" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'GroupServiceAccountDetails' [api-schema-removed]" + "exempt_until": "2024-07-10" + "reason": "Simplification" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'OrgServiceAccountDetails' [api-schema-removed]" + "exempt_until": "2024-07-10" + "reason": "Simplification" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ServiceAccountSecretDetails' [api-schema-removed]" + "exempt_until": "2024-07-10" + "reason": "Simplification" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/liveMigrations removed the request property 'dropEnabled' [request-property-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/liveMigrations/validate removed the request property 'dropEnabled' [request-property-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "API None None removed the schema 'ExampleResourceResponseView20230201' [api-schema-removed]." + "exempt_until": "2024-07-10" + "reason": "Spec correction CLOUDP-257947" +- "breaking_change_description": "API None None removed the schema 'ExampleResourceResponseView20230101' [api-schema-removed]." + "exempt_until": "2024-07-10" + "reason": "Spec correction CLOUDP-257947" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts the response property 'results/items/secrets/items/maskedSecretValue' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Simplification" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} the response property 'secrets/items/maskedSecretValue' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Simplification" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} the response property 'secrets/items/maskedSecretValue' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Simplification" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts the response property 'results/items/secrets/items/maskedSecretValue' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Simplification" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} the response property 'secrets/items/maskedSecretValue' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Simplification" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId} the response property 'secrets/items/maskedSecretValue' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Simplification" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs removed the enum value 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/alertConfigs removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the enum value 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'M0_CLUSTERS_PER_GROUP_WITHIN_LIMIT' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'M0_CLUSTERS_PER_GROUP_WITHIN_LIMIT' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/events/{eventId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/alertConfigs removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/alertConfigs removed the enum value 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/alertConfigs removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} removed the enum value 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "PUT /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/alertConfigs/{alertConfigId}/alerts removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/alerts removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/alerts/{alertId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "PATCH /api/atlas/v1.0/groups/{groupId}/alerts/{alertId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/alerts/{alertId}/alertConfigs removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/events removed the 'M0_CLUSTERS_PER_GROUP_WITHIN_LIMIT' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/events removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/events/{eventId} removed the 'M0_CLUSTERS_PER_GROUP_WITHIN_LIMIT' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/events/{eventId} removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #12: Group Event Types]/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Deprecated events removed" + "hide_from_changelog": "false" +- "breaking_change_description": "removed the schema 'ApiAtlasClusterDescriptionResource20240710' [api-schema-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec correction" + "hide_from_changelog": "false" +- "breaking_change_description": "removed the schema 'ApiAtlasDataLakeAzureRegionView' [api-schema-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation the response property '/items/cloudProviderConfig/aws' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation removed the 'GCP' enum value from the '/items/dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation removed the 'SERVERLESS' enum value from the '/items/dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation removed the 'TENANT' enum value from the '/items/dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation removed the enum value 'GCP' of the request property 'dataProcessRegion/cloudProvider' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation removed the enum value 'SERVERLESS' of the request property 'dataProcessRegion/cloudProvider' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation removed the enum value 'TENANT' of the request property 'dataProcessRegion/cloudProvider' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation removed '#/components/schemas/ApiAtlasDataLakeAzureRegionView' from the 'dataProcessRegion/region' request property 'oneOf' list [request-property-one-of-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation the response property 'cloudProviderConfig/aws' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation removed the 'GCP' enum value from the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation removed the 'SERVERLESS' enum value from the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation removed the 'TENANT' enum value from the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} the response property 'cloudProviderConfig/aws' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed the 'GCP' enum value from the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed the 'SERVERLESS' enum value from the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed the 'TENANT' enum value from the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed the enum value 'GCP' of the request property 'dataProcessRegion/cloudProvider' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed the enum value 'SERVERLESS' of the request property 'dataProcessRegion/cloudProvider' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed the enum value 'TENANT' of the request property 'dataProcessRegion/cloudProvider' [request-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed '#/components/schemas/ApiAtlasDataLakeAzureRegionView' from the 'dataProcessRegion/region' request property 'oneOf' list [request-property-one-of-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} the response property 'cloudProviderConfig/aws' became optional for the status '200' [response-property-became-optional]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed the 'GCP' enum value from the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed the 'SERVERLESS' enum value from the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} removed the 'TENANT' enum value from the 'dataProcessRegion/cloudProvider' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation added the new 'MONTREAL_CAN' enum value to the '/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiAtlasDataLakeAWSRegionView]/' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation added the new 'TOKYO_JPN' enum value to the '/items/dataProcessRegion/region/oneOf[#/components/schemas/ApiAtlasDataLakeAWSRegionView]/' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation added the new 'MONTREAL_CAN' enum value to the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiAtlasDataLakeAWSRegionView]/' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/dataFederation added the new 'TOKYO_JPN' enum value to the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiAtlasDataLakeAWSRegionView]/' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} added the new 'MONTREAL_CAN' enum value to the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiAtlasDataLakeAWSRegionView]/' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} added the new 'TOKYO_JPN' enum value to the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiAtlasDataLakeAWSRegionView]/' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} added the new 'MONTREAL_CAN' enum value to the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiAtlasDataLakeAWSRegionView]/' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName} added the new 'TOKYO_JPN' enum value to the 'dataProcessRegion/region/oneOf[#/components/schemas/ApiAtlasDataLakeAWSRegionView]/' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-07-10" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/apiKeys/{apiUserId} removed the success response with the status '200' [response-success-status-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId} removed the success response with the status '200' [response-success-status-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'AWSHardwareSpec20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'AWSRegionConfig20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'AzureRegionConfig20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'CloudRegionConfig20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ClusterDescriptionProcessArgs20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'DedicatedHardwareSpec20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'DeleteCopiedBackups20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'DiskBackupCopySetting20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'DiskBackupSnapshotSchedule20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'GCPHardwareSpec20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'GCPRegionConfig20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'HardwareSpec20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'PaginatedUSSInstance20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'TenantHardwareSpec20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'TenantRegionConfig20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'USSBackupSettings20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'USSConnectionStrings20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'USSInstanceDescription20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'USSInstanceDescriptionCreate20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'USSProviderSettings20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'USSProviderSettingsCreate20240710' [api-schema-removed]" + "exempt_until": "2024-08-10" + "reason": "Spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets the request property 'bucketName' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets the request property 'cloudProvider' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets the request property 'iamRoleId' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets/{exportBucketId} for the 'path' request parameter 'exportBucketId', the maxLength was decreased from '63' to '24' [request-parameter-max-length-decreased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets/{exportBucketId} for the 'path' request parameter 'exportBucketId', the minLength was increased from '3' to '24' [request-parameter-min-length-increased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets/{exportBucketId} for the 'path' request parameter 'exportBucketId', the maxLength was decreased from '63' to '24' [request-parameter-max-length-decreased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets/{exportBucketId} for the 'path' request parameter 'exportBucketId', the minLength was increased from '3' to '24' [request-parameter-min-length-increased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property '/oneOf[#/components/schemas/DiskBackupSnapshotAWSExportBucket]/bucketName' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property '/oneOf[#/components/schemas/DiskBackupSnapshotAWSExportBucket]/iamRoleId' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/bucketName' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/roleId' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/serviceUrl' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/tenantId' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property 'bucketName' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/serviceUrl' request property's minLength was increased from '0' to '1' [request-property-min-length-increased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} for the 'path' request parameter 'exportBucketId', the maxLength was decreased from '63' to '24' [request-parameter-max-length-decreased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} for the 'path' request parameter 'exportBucketId', the minLength was increased from '3' to '24' [request-parameter-min-length-increased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} for the 'path' request parameter 'exportBucketId', the maxLength was decreased from '63' to '24' [request-parameter-max-length-decreased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} for the 'path' request parameter 'exportBucketId', the minLength was increased from '3' to '24' [request-parameter-min-length-increased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property '/oneOf[#/components/schemas/DiskBackupSnapshotAWSExportBucket]/cloudProvider' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/cloudProvider' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the request property 'cloudProvider' became required [request-property-became-required]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/tenantId' request property's minLength was increased from '32' to '36' [request-property-min-length-increased]." + "exempt_until": "2024-08-07" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/eventTypes the response's body type/format changed from 'array'/'' to 'object'/'' for status '200' [response-body-type-changed]" + "exempt_until": "2024-08-05" + "reason": "Fix incorrect arraySchema annotation" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders request property '/oneOf[subschema #1: OIDC WORKFORCE]/protocol' was restricted to a list of enum values [request-property-became-enum]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders request property '/oneOf[subschema #2: OIDC WORKLOAD]/protocol' was restricted to a list of enum values [request-property-became-enum]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders request property 'protocol' was restricted to a list of enum values [request-property-became-enum]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} request property '/oneOf[subschema #1: SAML]/protocol' was restricted to a list of enum values [request-property-became-enum]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction " + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} request property '/oneOf[subschema #2: OIDC WORKFORCE]/protocol' was restricted to a list of enum values [request-property-became-enum]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} request property '/oneOf[subschema #3: OIDC WORKLOAD]/protocol' was restricted to a list of enum values [request-property-became-enum]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} request property 'protocol' was restricted to a list of enum values [request-property-became-enum]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'OIDC' enum value to the 'results/items/oneOf[subschema #1: SAML]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'OIDC' enum value to the 'results/items/oneOf[subschema #2: OIDC WORKFORCE]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'OIDC' enum value to the 'results/items/oneOf[subschema #3: OIDC WORKLOAD]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'OIDC' enum value to the 'results/items/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'SAML' enum value to the 'results/items/oneOf[subschema #1: SAML]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'SAML' enum value to the 'results/items/oneOf[subschema #2: OIDC WORKFORCE]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'SAML' enum value to the 'results/items/oneOf[subschema #3: OIDC WORKLOAD]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'SAML' enum value to the 'results/items/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'OIDC' enum value to the '/oneOf[subschema #1: OIDC WORKFORCE]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'OIDC' enum value to the '/oneOf[subschema #2: OIDC WORKLOAD]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'OIDC' enum value to the 'protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'SAML' enum value to the '/oneOf[subschema #1: OIDC WORKFORCE]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'SAML' enum value to the '/oneOf[subschema #2: OIDC WORKLOAD]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders added the new 'SAML' enum value to the 'protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'OIDC' enum value to the '/oneOf[subschema #1: SAML]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'OIDC' enum value to the '/oneOf[subschema #2: OIDC WORKFORCE]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'OIDC' enum value to the '/oneOf[subschema #3: OIDC WORKLOAD]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'OIDC' enum value to the 'protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'SAML' enum value to the '/oneOf[subschema #1: SAML]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'SAML' enum value to the '/oneOf[subschema #2: OIDC WORKFORCE]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'SAML' enum value to the '/oneOf[subschema #3: OIDC WORKLOAD]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'SAML' enum value to the 'protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'OIDC' enum value to the '/oneOf[subschema #1: SAML]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'OIDC' enum value to the '/oneOf[subschema #2: OIDC WORKFORCE]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'OIDC' enum value to the '/oneOf[subschema #3: OIDC WORKLOAD]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'OIDC' enum value to the 'protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'SAML' enum value to the '/oneOf[subschema #1: SAML]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'SAML' enum value to the '/oneOf[subschema #2: OIDC WORKFORCE]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'SAML' enum value to the '/oneOf[subschema #3: OIDC WORKLOAD]/protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId} added the new 'SAML' enum value to the 'protocol' response property for the response status '200' [response-property-enum-value-added]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index removed the request property 'options/unique' [request-property-removed]" + "exempt_until": "2024-08-05" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/serviceUrl' request property's maxLength was decreased to '55' [request-property-max-length-decreased]" + "exempt_until": "2024-08-05" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/serviceUrl' request property's maxLength was decreased to '55' [request-property-max-length-decreased]" + "exempt_until": "2024-08-05" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the '/oneOf[#/components/schemas/DiskBackupSnapshotAWSExportBucket]/bucketName' request property's minLength was increased from '0' to '3' [request-property-min-length-increased]" + "exempt_until": "2024-08-05" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/bucketName' request property's minLength was increased from '0' to '3' [request-property-min-length-increased]" + "exempt_until": "2024-08-05" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/serviceUrl' request property's minLength was increased from '1' to '33' [request-property-min-length-increased]" + "exempt_until": "2024-08-05" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the 'bucketName' request property's minLength was increased from '0' to '3' [request-property-min-length-increased]" + "exempt_until": "2024-08-05" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v1.0/groups/{groupId}/backup/exportBuckets the 'bucketName' request property's minLength was increased from '0' to '3' [request-property-min-length-increased]" + "exempt_until": "2024-08-05" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets the '/oneOf[#/components/schemas/DiskBackupSnapshotAzureExportBucket]/serviceUrl' request property's minLength was increased from '0' to '33' [request-property-min-length-increased]." + "exempt_until": "2024-08-05" + "reason": "spec correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_AUTOMATION_ADMIN' enum value from the 'results/items/roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_BACKUP_ADMIN' enum value from the 'results/items/roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_MONITORING_ADMIN' enum value from the 'results/items/roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_USER_ADMIN' enum value from the 'results/items/roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the enum value 'GROUP_AUTOMATION_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the enum value 'GROUP_BACKUP_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the enum value 'GROUP_MONITORING_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the enum value 'GROUP_USER_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_AUTOMATION_ADMIN' enum value from the 'roles/items/' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_BACKUP_ADMIN' enum value from the 'roles/items/' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_MONITORING_ADMIN' enum value from the 'roles/items/' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts removed the 'GROUP_USER_ADMIN' enum value from the 'roles/items/' response property for the response status '201' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_AUTOMATION_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_BACKUP_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_MONITORING_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_USER_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_AUTOMATION_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_BACKUP_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_MONITORING_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_USER_ADMIN' of the request property 'roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_AUTOMATION_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_BACKUP_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_MONITORING_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the 'GROUP_USER_ADMIN' enum value from the 'roles/items/' response property for the response status '200' [response-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_AUTOMATION_ADMIN' of the request property '/items/roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_BACKUP_ADMIN' of the request property '/items/roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_MONITORING_ADMIN' of the request property '/items/roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId} removed the enum value 'GROUP_USER_ADMIN' of the request property '/items/roles/items/' [request-property-enum-value-removed]" + "exempt_until": "2024-08-05" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ManagedNamespaceView' [api-schema-removed]" + "exempt_until": "2024-08-06" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces the request property 'collection' became required [request-property-became-required]" + "exempt_until": "2024-08-06" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces the request property 'db' became required [request-property-became-required]" + "exempt_until": "2024-08-06" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces the 'numInitialChunks' request property's max was set to '8192.00' [request-property-max-set]" + "exempt_until": "2024-08-06" + "reason": "Spec Correction" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'AWSHardwareSpec20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'AWSRegionConfig20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'AzureHardwareSpec20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'AzureRegionConfig20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'CloudRegionConfig20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ClusterDescription20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ClusterDescriptionProcessArgs20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'DedicatedHardwareSpec20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'DeleteCopiedBackups20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'DiskBackupCopySetting20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'DiskBackupSnapshotSchedule20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'GCPHardwareSpec20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'GCPRegionConfig20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'GeoSharding20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'HardwareSpec20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'PaginatedClusterDescription20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'ReplicationSpec20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'TenantHardwareSpec20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "removed the schema 'TenantRegionConfig20250101' [api-schema-removed]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule api sunset date changed to earlier date from '2026-01-01' to '2025-08-05', new sunset date must be not earlier than '2026-01-01' at least '365' days from now [api-sunset-date-changed-too-small]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule api sunset date changed to earlier date from '2026-01-01' to '2025-08-05', new sunset date must be not earlier than '2026-01-01' at least '365' days from now [api-sunset-date-changed-too-small]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule api sunset date changed to earlier date from '2026-01-01' to '2025-08-05', new sunset date must be not earlier than '2026-01-01' at least '365' days from now [api-sunset-date-changed-too-small]" + "exempt_until": "2024-08-07" + "reason": "unhiding new api version" + "hide_from_changelog": "true" +- "breaking_change_description": "DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule sunset date '2025-08-05' is too small, must be at least '365' days from now [api-sunset-date-too-small]" + "exempt_until": "2024-08-06" + "reason": "Release was delayed 1 day" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule sunset date '2025-08-05' is too small, must be at least '365' days from now [api-sunset-date-too-small]" + "exempt_until": "2024-08-06" + "reason": "Release was delayed 1 day" + "hide_from_changelog": "true" +- "breaking_change_description": "PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule sunset date '2025-08-05' is too small, must be at least '365' days from now [api-sunset-date-too-small]" + "exempt_until": "2024-08-06" + "reason": "Release was delayed 1 day" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor the 'pipeline' request property type/format changed from 'string'/'' to 'array'/'' [request-property-type-changed]" + "exempt_until": "2024-08-08" + "reason": "Changing semantics of providing pipeline and optional configuration for a stream processor" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor the 'pipeline' response's property type/format changed from 'string'/'' to 'array'/'' for status '200' [response-property-type-changed]" + "exempt_until": "2024-08-08" + "reason": "Changing semantics of providing pipeline and optional configuration for a stream processor" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName} the 'pipeline' response's property type/format changed from 'string'/'' to 'array'/'' for status '200' [response-property-type-changed]" + "exempt_until": "2024-08-08" + "reason": "Changing semantics of providing pipeline and optional configuration for a stream processor" + "hide_from_changelog": "true" +- "breaking_change_description": "GET /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors the 'results/items/pipeline' response's property type/format changed from 'string'/'' to 'array'/'' for status '200' [response-property-type-changed]" + "exempt_until": "2024-08-08" + "reason": "Changing semantics of providing pipeline and optional configuration for a stream processor" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor removed the request property 'dlq' [request-property-removed]" + "exempt_until": "2024-08-08" + "reason": "Changing semantics of providing pipeline and optional configuration for a stream processor" + "hide_from_changelog": "true" +- "breaking_change_description": "POST /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor removed the optional property 'dlq' from the response with the '200' status [response-optional-property-removed]" + "exempt_until": "2024-08-08" + "reason": "Changing semantics of providing pipeline and optional configuration for a stream processor" + "hide_from_changelog": "true" \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-02-01.json b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-02-01.json new file mode 100644 index 000000000..f15572f97 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-02-01.json @@ -0,0 +1,364 @@ +[ + { + "path": "/api/atlas/v2/groups/{groupId}/access", + "httpMethod": "POST", + "operationId": "addUserToProject", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "operationId": "listClusters", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'results/items/replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/autoScaling, results/items/mongoURI, results/items/mongoURIUpdated, results/items/mongoURIWithOptions, results/items/numShards, results/items/providerBackupEnabled, results/items/providerSettings, results/items/replicationFactor, results/items/replicationSpec, results/items/replicationSpecs/items/regionsConfig, results/items/srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'results/items/mongoDBVersion, results/items/replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'replicationSpecs/items/numShards' request property's min was set to '1.00'", + "changeCode": "request-property-min-set", + "backwardCompatible": true + }, + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' request property default value '1.00' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "operationId": "getCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'replicationSpecs/items/numShards' request property's min was set to '1.00'", + "changeCode": "request-property-min-set", + "backwardCompatible": true + }, + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' request property default value '1.00' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "GET", + "operationId": "listStreamInstances", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "POST", + "operationId": "createStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "GET", + "operationId": "getStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "PATCH", + "operationId": "updateStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs", + "httpMethod": "GET", + "operationId": "downloadStreamTenantAuditLogs", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "GET", + "operationId": "listStreamConnections", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "POST", + "operationId": "createStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "GET", + "operationId": "getStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "PATCH", + "operationId": "updateStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-10-01.json b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-10-01.json new file mode 100644 index 000000000..cce68d6b5 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-10-01.json @@ -0,0 +1,395 @@ +[ + { + "path": "/api/atlas/v2/groups/{groupId}/access", + "httpMethod": "POST", + "operationId": "addUserToProject", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "GET", + "operationId": "getDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "PUT", + "operationId": "updateDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + }, + { + "change": "the request properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "request-property-became-required", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "operationId": "listClusters", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'results/items/replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/autoScaling, results/items/mongoURI, results/items/mongoURIUpdated, results/items/mongoURIWithOptions, results/items/numShards, results/items/providerBackupEnabled, results/items/providerSettings, results/items/replicationFactor, results/items/replicationSpec, results/items/replicationSpecs/items/regionsConfig, results/items/srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'results/items/mongoDBVersion, results/items/replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'replicationSpecs/items/numShards' request property's min was set to '1.00'", + "changeCode": "request-property-min-set", + "backwardCompatible": true + }, + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' request property default value '1.00' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "operationId": "getCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'replicationSpecs/items/numShards' request property's min was set to '1.00'", + "changeCode": "request-property-min-set", + "backwardCompatible": true + }, + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' request property default value '1.00' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "GET", + "operationId": "listStreamInstances", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "POST", + "operationId": "createStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "GET", + "operationId": "getStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "PATCH", + "operationId": "updateStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs", + "httpMethod": "GET", + "operationId": "downloadStreamTenantAuditLogs", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "GET", + "operationId": "listStreamConnections", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "POST", + "operationId": "createStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "GET", + "operationId": "getStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "PATCH", + "operationId": "updateStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-11-15.json b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-11-15.json new file mode 100644 index 000000000..c4d0246a0 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2023-11-15.json @@ -0,0 +1,610 @@ +[ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "operationId": "createIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "DELETE", + "operationId": "deleteIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "GET", + "operationId": "getIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks", + "httpMethod": "DELETE", + "operationId": "revokeJwksFromIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/access", + "httpMethod": "POST", + "operationId": "addUserToProject", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "GET", + "operationId": "getDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "PUT", + "operationId": "updateDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + }, + { + "change": "the request properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "request-property-became-required", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "operationId": "listClusters", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'results/items/replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/autoScaling, results/items/mongoURI, results/items/mongoURIUpdated, results/items/mongoURIWithOptions, results/items/numShards, results/items/providerBackupEnabled, results/items/providerSettings, results/items/replicationFactor, results/items/replicationSpec, results/items/replicationSpecs/items/regionsConfig, results/items/srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'results/items/mongoDBVersion, results/items/replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'replicationSpecs/items/numShards' request property's min was set to '1.00'", + "changeCode": "request-property-min-set", + "backwardCompatible": true + }, + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' request property default value '1.00' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "operationId": "getCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'replicationSpecs/items/numShards' request property's min was set to '1.00'", + "changeCode": "request-property-min-set", + "backwardCompatible": true + }, + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' request property default value '1.00' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "GET", + "operationId": "getPinnedNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PATCH", + "operationId": "pinNamespacesPatch", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PUT", + "operationId": "pinNamespacesPut", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin", + "httpMethod": "PATCH", + "operationId": "unpinNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForCluster", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/collStats/metrics", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceMetrics", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForHost", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceHostMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "GET", + "operationId": "listStreamInstances", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "POST", + "operationId": "createStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "GET", + "operationId": "getStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "PATCH", + "operationId": "updateStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs", + "httpMethod": "GET", + "operationId": "downloadStreamTenantAuditLogs", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "GET", + "operationId": "listStreamConnections", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "POST", + "operationId": "createStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "GET", + "operationId": "getStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "PATCH", + "operationId": "updateStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/unauth/controlPlaneIPAddresses", + "httpMethod": "GET", + "operationId": "returnAllControlPlaneIPAddresses", + "tag": "Root", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-01-01_2024-05-30.json b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2024-05-30.json new file mode 100644 index 000000000..521f5f10f --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2024-05-30.json @@ -0,0 +1,989 @@ +[ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "operationId": "createIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "DELETE", + "operationId": "deleteIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "GET", + "operationId": "getIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks", + "httpMethod": "DELETE", + "operationId": "revokeJwksFromIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/access", + "httpMethod": "POST", + "operationId": "addUserToProject", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "operationId": "acknowledgeAlert", + "tag": "Alerts", + "changes": [ + { + "change": "added the new optional request property 'unacknowledgeAlert'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "operationId": "listExportBuckets", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added discriminator to 'results/items/' response property", + "changeCode": "response-property-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the 'results/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'results/items/iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "operationId": "createExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added request discriminator", + "changeCode": "request-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request property 'iamRoleId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "operationId": "getExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "GET", + "operationId": "getDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "PUT", + "operationId": "updateDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + }, + { + "change": "the request properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "request-property-became-required", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "operationId": "listClusters", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'results/items/replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/autoScaling, results/items/mongoURI, results/items/mongoURIUpdated, results/items/mongoURIWithOptions, results/items/numShards, results/items/providerBackupEnabled, results/items/providerSettings, results/items/replicationFactor, results/items/replicationSpec, results/items/replicationSpecs/items/regionsConfig, results/items/srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'results/items/mongoDBVersion, results/items/replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'replicationSpecs/items/numShards' request property's min was set to '1.00'", + "changeCode": "request-property-min-set", + "backwardCompatible": true + }, + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' request property default value '1.00' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "operationId": "getCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'replicationSpecs/items/numShards' request property's min was set to '1.00'", + "changeCode": "request-property-min-set", + "backwardCompatible": true + }, + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' request property default value '1.00' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'numShards' response's property default value '1.00' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "added the optional property 'replicationSpecs/items/regionConfigs' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "GET", + "operationId": "getPinnedNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PATCH", + "operationId": "pinNamespacesPatch", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PUT", + "operationId": "pinNamespacesPut", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin", + "httpMethod": "PATCH", + "operationId": "unpinNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "POST", + "operationId": "createAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '201'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexesCluster", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "POST", + "operationId": "createAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexes", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForCluster", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/collStats/metrics", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceMetrics", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations", + "httpMethod": "POST", + "operationId": "createPushMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations/validate", + "httpMethod": "POST", + "operationId": "validateMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForHost", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceHostMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "GET", + "operationId": "listStreamInstances", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "POST", + "operationId": "createStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "GET", + "operationId": "getStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "PATCH", + "operationId": "updateStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs", + "httpMethod": "GET", + "operationId": "downloadStreamTenantAuditLogs", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "GET", + "operationId": "listStreamConnections", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "POST", + "operationId": "createStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "GET", + "operationId": "getStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "PATCH", + "operationId": "updateStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "httpMethod": "POST", + "operationId": "createStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "operationId": "getStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "operationId": "startStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "operationId": "stopStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "operationId": "listStreamProcessors", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}:migrate", + "httpMethod": "POST", + "operationId": "migrateProjectToAnotherOrg", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/unauth/controlPlaneIPAddresses", + "httpMethod": "GET", + "operationId": "returnAllControlPlaneIPAddresses", + "tag": "Root", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-01-01_2024-08-05.json b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2024-08-05.json new file mode 100644 index 000000000..7071331da --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-01-01_2024-08-05.json @@ -0,0 +1,1060 @@ +[ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "operationId": "createIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "DELETE", + "operationId": "deleteIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "GET", + "operationId": "getIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks", + "httpMethod": "DELETE", + "operationId": "revokeJwksFromIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/access", + "httpMethod": "POST", + "operationId": "addUserToProject", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "operationId": "acknowledgeAlert", + "tag": "Alerts", + "changes": [ + { + "change": "added the new optional request property 'unacknowledgeAlert'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "operationId": "listExportBuckets", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added discriminator to 'results/items/' response property", + "changeCode": "response-property-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the 'results/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'results/items/iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "operationId": "createExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added request discriminator", + "changeCode": "request-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request property 'iamRoleId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "operationId": "getExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "GET", + "operationId": "getDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "PUT", + "operationId": "updateDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + }, + { + "change": "the request properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "request-property-became-required", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "operationId": "listClusters", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'results/items/replicationSpecs/items/regionConfigs, results/items/replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/autoScaling, results/items/diskSizeGB, results/items/mongoURI, results/items/mongoURIUpdated, results/items/mongoURIWithOptions, results/items/numShards, results/items/providerBackupEnabled, results/items/providerSettings, results/items/replicationFactor, results/items/replicationSpec, results/items/replicationSpecs/items/numShards, results/items/replicationSpecs/items/regionsConfig, results/items/srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'results/items/mongoDBVersion, results/items/replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, diskSizeGB, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/numShards, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, diskSizeGB, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/numShards, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "operationId": "getCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, diskSizeGB, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/numShards, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "the request optional property 'mongoDBVersion' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'replicationSpecs/items/id' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' request property default value 'false' was added", + "changeCode": "request-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "the 'backupEnabled' response's property default value 'false' was added", + "changeCode": "response-property-default-value-added", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'autoScaling, diskSizeGB, mongoURI, mongoURIUpdated, mongoURIWithOptions, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/numShards, replicationSpecs/items/regionsConfig, srvAddress' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'autoScaling, diskSizeGB, numShards, providerBackupEnabled, providerSettings, replicationFactor, replicationSpec, replicationSpecs/items/numShards, replicationSpecs/items/regionsConfig'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the response optional properties 'mongoDBVersion, replicationSpecs/items/id' became read-only", + "changeCode": "response-optional-property-became-read-only", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "DELETE", + "operationId": "deleteAllBackupSchedules", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "GET", + "operationId": "getBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "PATCH", + "operationId": "updateBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new required request property 'copySettings/items/zoneId'", + "changeCode": "new-required-request-property", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'copySettings/items/replicationSpecId, deleteCopiedBackups/items/replicationSpecId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "GET", + "operationId": "getPinnedNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PATCH", + "operationId": "pinNamespacesPatch", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PUT", + "operationId": "pinNamespacesPut", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin", + "httpMethod": "PATCH", + "operationId": "unpinNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "GET", + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "POST", + "operationId": "createAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '201'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexesCluster", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "POST", + "operationId": "createAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexes", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForCluster", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/collStats/metrics", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceMetrics", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations", + "httpMethod": "POST", + "operationId": "createPushMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations/validate", + "httpMethod": "POST", + "operationId": "validateMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForHost", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceHostMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "GET", + "operationId": "listStreamInstances", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams", + "httpMethod": "POST", + "operationId": "createStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "GET", + "operationId": "getStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}", + "httpMethod": "PATCH", + "operationId": "updateStreamInstance", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs", + "httpMethod": "GET", + "operationId": "downloadStreamTenantAuditLogs", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "GET", + "operationId": "listStreamConnections", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections", + "httpMethod": "POST", + "operationId": "createStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "GET", + "operationId": "getStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}", + "httpMethod": "PATCH", + "operationId": "updateStreamConnection", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "httpMethod": "POST", + "operationId": "createStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "operationId": "getStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "operationId": "startStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "operationId": "stopStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "operationId": "listStreamProcessors", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}:migrate", + "httpMethod": "POST", + "operationId": "migrateProjectToAnotherOrg", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/unauth/controlPlaneIPAddresses", + "httpMethod": "GET", + "operationId": "returnAllControlPlaneIPAddresses", + "tag": "Root", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-02-01_2023-10-01.json b/tools/cli/test/data/changelog/new-version/output/2023-02-01_2023-10-01.json new file mode 100644 index 000000000..56bb1fcc6 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-02-01_2023-10-01.json @@ -0,0 +1,33 @@ +[ + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "GET", + "operationId": "getDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "PUT", + "operationId": "updateDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + }, + { + "change": "the request properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "request-property-became-required", + "backwardCompatible": false + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-02-01_2023-11-15.json b/tools/cli/test/data/changelog/new-version/output/2023-02-01_2023-11-15.json new file mode 100644 index 000000000..bd74de6b0 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-02-01_2023-11-15.json @@ -0,0 +1,248 @@ +[ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "operationId": "createIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "DELETE", + "operationId": "deleteIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "GET", + "operationId": "getIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks", + "httpMethod": "DELETE", + "operationId": "revokeJwksFromIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "GET", + "operationId": "getDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "PUT", + "operationId": "updateDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + }, + { + "change": "the request properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "request-property-became-required", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "GET", + "operationId": "getPinnedNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PATCH", + "operationId": "pinNamespacesPatch", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PUT", + "operationId": "pinNamespacesPut", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin", + "httpMethod": "PATCH", + "operationId": "unpinNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForCluster", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/collStats/metrics", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceMetrics", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForHost", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceHostMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/unauth/controlPlaneIPAddresses", + "httpMethod": "GET", + "operationId": "returnAllControlPlaneIPAddresses", + "tag": "Root", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-02-01_2024-05-30.json b/tools/cli/test/data/changelog/new-version/output/2023-02-01_2024-05-30.json new file mode 100644 index 000000000..10dc7d916 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-02-01_2024-05-30.json @@ -0,0 +1,627 @@ +[ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "operationId": "createIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "DELETE", + "operationId": "deleteIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "GET", + "operationId": "getIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks", + "httpMethod": "DELETE", + "operationId": "revokeJwksFromIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "operationId": "acknowledgeAlert", + "tag": "Alerts", + "changes": [ + { + "change": "added the new optional request property 'unacknowledgeAlert'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "operationId": "listExportBuckets", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added discriminator to 'results/items/' response property", + "changeCode": "response-property-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the 'results/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'results/items/iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "operationId": "createExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added request discriminator", + "changeCode": "request-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request property 'iamRoleId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "operationId": "getExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "GET", + "operationId": "getDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "PUT", + "operationId": "updateDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + }, + { + "change": "the request properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "request-property-became-required", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "GET", + "operationId": "getPinnedNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PATCH", + "operationId": "pinNamespacesPatch", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PUT", + "operationId": "pinNamespacesPut", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin", + "httpMethod": "PATCH", + "operationId": "unpinNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "POST", + "operationId": "createAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '201'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexesCluster", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "POST", + "operationId": "createAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexes", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForCluster", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/collStats/metrics", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceMetrics", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations", + "httpMethod": "POST", + "operationId": "createPushMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations/validate", + "httpMethod": "POST", + "operationId": "validateMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForHost", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceHostMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "httpMethod": "POST", + "operationId": "createStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "operationId": "getStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "operationId": "startStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "operationId": "stopStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "operationId": "listStreamProcessors", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}:migrate", + "httpMethod": "POST", + "operationId": "migrateProjectToAnotherOrg", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/unauth/controlPlaneIPAddresses", + "httpMethod": "GET", + "operationId": "returnAllControlPlaneIPAddresses", + "tag": "Root", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-02-01_2024-08-05.json b/tools/cli/test/data/changelog/new-version/output/2023-02-01_2024-08-05.json new file mode 100644 index 000000000..be5972513 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-02-01_2024-08-05.json @@ -0,0 +1,1070 @@ +[ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "operationId": "createIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "DELETE", + "operationId": "deleteIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "GET", + "operationId": "getIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks", + "httpMethod": "DELETE", + "operationId": "revokeJwksFromIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "operationId": "acknowledgeAlert", + "tag": "Alerts", + "changes": [ + { + "change": "added the new optional request property 'unacknowledgeAlert'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "operationId": "listExportBuckets", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added discriminator to 'results/items/' response property", + "changeCode": "response-property-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the 'results/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'results/items/iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "operationId": "createExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added request discriminator", + "changeCode": "request-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request property 'iamRoleId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "operationId": "getExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "GET", + "operationId": "getDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy", + "httpMethod": "PUT", + "operationId": "updateDataProtectionSettings", + "tag": "Cloud Backups", + "changes": [ + { + "change": "the response properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + }, + { + "change": "the request properties 'authorizedUserFirstName, authorizedUserLastName' became required", + "changeCode": "request-property-became-required", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "operationId": "listClusters", + "tag": "Clusters", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, results/items/replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/diskSizeGB, results/items/replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "operationId": "getCluster", + "tag": "Clusters", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "DELETE", + "operationId": "deleteAllBackupSchedules", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "GET", + "operationId": "getBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "PATCH", + "operationId": "updateBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new required request property 'copySettings/items/zoneId'", + "changeCode": "new-required-request-property", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'copySettings/items/replicationSpecId, deleteCopiedBackups/items/replicationSpecId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "GET", + "operationId": "getPinnedNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PATCH", + "operationId": "pinNamespacesPatch", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PUT", + "operationId": "pinNamespacesPut", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin", + "httpMethod": "PATCH", + "operationId": "unpinNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "GET", + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "POST", + "operationId": "createAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '201'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexesCluster", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "POST", + "operationId": "createAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexes", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForCluster", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/collStats/metrics", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceMetrics", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations", + "httpMethod": "POST", + "operationId": "createPushMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations/validate", + "httpMethod": "POST", + "operationId": "validateMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForHost", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceHostMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "httpMethod": "POST", + "operationId": "createStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "operationId": "getStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "operationId": "startStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "operationId": "stopStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "operationId": "listStreamProcessors", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}:migrate", + "httpMethod": "POST", + "operationId": "migrateProjectToAnotherOrg", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/unauth/controlPlaneIPAddresses", + "httpMethod": "GET", + "operationId": "returnAllControlPlaneIPAddresses", + "tag": "Root", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-10-01_2023-11-15.json b/tools/cli/test/data/changelog/new-version/output/2023-10-01_2023-11-15.json new file mode 100644 index 000000000..15f7abce7 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-10-01_2023-11-15.json @@ -0,0 +1,217 @@ +[ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "operationId": "createIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "DELETE", + "operationId": "deleteIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "GET", + "operationId": "getIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks", + "httpMethod": "DELETE", + "operationId": "revokeJwksFromIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "GET", + "operationId": "getPinnedNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PATCH", + "operationId": "pinNamespacesPatch", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PUT", + "operationId": "pinNamespacesPut", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin", + "httpMethod": "PATCH", + "operationId": "unpinNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForCluster", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/collStats/metrics", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceMetrics", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForHost", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceHostMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/unauth/controlPlaneIPAddresses", + "httpMethod": "GET", + "operationId": "returnAllControlPlaneIPAddresses", + "tag": "Root", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-10-01_2024-05-30.json b/tools/cli/test/data/changelog/new-version/output/2023-10-01_2024-05-30.json new file mode 100644 index 000000000..e14b3eed8 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-10-01_2024-05-30.json @@ -0,0 +1,596 @@ +[ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "operationId": "createIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "DELETE", + "operationId": "deleteIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "GET", + "operationId": "getIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks", + "httpMethod": "DELETE", + "operationId": "revokeJwksFromIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "operationId": "acknowledgeAlert", + "tag": "Alerts", + "changes": [ + { + "change": "added the new optional request property 'unacknowledgeAlert'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "operationId": "listExportBuckets", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added discriminator to 'results/items/' response property", + "changeCode": "response-property-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the 'results/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'results/items/iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "operationId": "createExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added request discriminator", + "changeCode": "request-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request property 'iamRoleId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "operationId": "getExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "GET", + "operationId": "getPinnedNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PATCH", + "operationId": "pinNamespacesPatch", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PUT", + "operationId": "pinNamespacesPut", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin", + "httpMethod": "PATCH", + "operationId": "unpinNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "POST", + "operationId": "createAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '201'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexesCluster", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "POST", + "operationId": "createAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexes", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForCluster", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/collStats/metrics", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceMetrics", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations", + "httpMethod": "POST", + "operationId": "createPushMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations/validate", + "httpMethod": "POST", + "operationId": "validateMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForHost", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceHostMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "httpMethod": "POST", + "operationId": "createStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "operationId": "getStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "operationId": "startStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "operationId": "stopStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "operationId": "listStreamProcessors", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}:migrate", + "httpMethod": "POST", + "operationId": "migrateProjectToAnotherOrg", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/unauth/controlPlaneIPAddresses", + "httpMethod": "GET", + "operationId": "returnAllControlPlaneIPAddresses", + "tag": "Root", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-10-01_2024-08-05.json b/tools/cli/test/data/changelog/new-version/output/2023-10-01_2024-08-05.json new file mode 100644 index 000000000..c45d0fd38 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-10-01_2024-08-05.json @@ -0,0 +1,1039 @@ +[ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "operationId": "createIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "DELETE", + "operationId": "deleteIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "GET", + "operationId": "getIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "added '#/components/schemas/FederationSamlIdentityProviderUpdate, #/components/schemas/FederationOidcWorkforceIdentityProviderUpdate, #/components/schemas/FederationOidcWorkloadIdentityProviderUpdate' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/FederationSamlIdentityProvider, #/components/schemas/FederationOidcWorkforceIdentityProvider, #/components/schemas/FederationOidcWorkloadIdentityProvider' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'acsUrl, associatedDomains, audienceUri, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'associatedDomains, pemFileInfo, requestBinding, responseSignatureAlgorithm, slug, ssoDebugEnabled, ssoUrl, status'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks", + "httpMethod": "DELETE", + "operationId": "revokeJwksFromIdentityProvider", + "tag": "Federated Authentication", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "operationId": "acknowledgeAlert", + "tag": "Alerts", + "changes": [ + { + "change": "added the new optional request property 'unacknowledgeAlert'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "operationId": "listExportBuckets", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added discriminator to 'results/items/' response property", + "changeCode": "response-property-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the 'results/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'results/items/iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "operationId": "createExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added request discriminator", + "changeCode": "request-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request property 'iamRoleId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "operationId": "getExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "operationId": "listClusters", + "tag": "Clusters", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, results/items/replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/diskSizeGB, results/items/replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "operationId": "getCluster", + "tag": "Clusters", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "DELETE", + "operationId": "deleteAllBackupSchedules", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "GET", + "operationId": "getBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "PATCH", + "operationId": "updateBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new required request property 'copySettings/items/zoneId'", + "changeCode": "new-required-request-property", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'copySettings/items/replicationSpecId, deleteCopiedBackups/items/replicationSpecId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "GET", + "operationId": "getPinnedNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PATCH", + "operationId": "pinNamespacesPatch", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned", + "httpMethod": "PUT", + "operationId": "pinNamespacesPut", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin", + "httpMethod": "PATCH", + "operationId": "unpinNamespaces", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "GET", + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "POST", + "operationId": "createAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '201'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexesCluster", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "POST", + "operationId": "createAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexes", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForCluster", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/collStats/metrics", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceMetrics", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations", + "httpMethod": "POST", + "operationId": "createPushMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations/validate", + "httpMethod": "POST", + "operationId": "validateMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespacesForHost", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements", + "httpMethod": "GET", + "operationId": "getCollStatsLatencyNamespaceHostMeasurements", + "tag": "Collection Level Metrics", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "httpMethod": "POST", + "operationId": "createStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "operationId": "getStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "operationId": "startStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "operationId": "stopStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "operationId": "listStreamProcessors", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}:migrate", + "httpMethod": "POST", + "operationId": "migrateProjectToAnotherOrg", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/unauth/controlPlaneIPAddresses", + "httpMethod": "GET", + "operationId": "returnAllControlPlaneIPAddresses", + "tag": "Root", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-11-15_2024-05-30.json b/tools/cli/test/data/changelog/new-version/output/2023-11-15_2024-05-30.json new file mode 100644 index 000000000..05bd30bb6 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-11-15_2024-05-30.json @@ -0,0 +1,381 @@ +[ + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "operationId": "acknowledgeAlert", + "tag": "Alerts", + "changes": [ + { + "change": "added the new optional request property 'unacknowledgeAlert'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "operationId": "listExportBuckets", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added discriminator to 'results/items/' response property", + "changeCode": "response-property-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the 'results/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'results/items/iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "operationId": "createExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added request discriminator", + "changeCode": "request-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request property 'iamRoleId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "operationId": "getExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "POST", + "operationId": "createAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '201'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexesCluster", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "POST", + "operationId": "createAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexes", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations", + "httpMethod": "POST", + "operationId": "createPushMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations/validate", + "httpMethod": "POST", + "operationId": "validateMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "httpMethod": "POST", + "operationId": "createStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "operationId": "getStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "operationId": "startStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "operationId": "stopStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "operationId": "listStreamProcessors", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}:migrate", + "httpMethod": "POST", + "operationId": "migrateProjectToAnotherOrg", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2023-11-15_2024-08-05.json b/tools/cli/test/data/changelog/new-version/output/2023-11-15_2024-08-05.json new file mode 100644 index 000000000..1578aff61 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2023-11-15_2024-08-05.json @@ -0,0 +1,824 @@ +[ + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "operationId": "acknowledgeAlert", + "tag": "Alerts", + "changes": [ + { + "change": "added the new optional request property 'unacknowledgeAlert'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "operationId": "listExportBuckets", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added discriminator to 'results/items/' response property", + "changeCode": "response-property-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the 'results/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'results/items/iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "operationId": "createExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added request discriminator", + "changeCode": "request-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the request body 'oneOf' list", + "changeCode": "request-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + }, + { + "change": "removed the request property 'iamRoleId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "operationId": "getExportBucket", + "tag": "Cloud Backups", + "changes": [ + { + "change": "added response discriminator for the response status '200'", + "changeCode": "response-body-discriminator-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DiskBackupSnapshotAWSExportBucket, #/components/schemas/DiskBackupSnapshotAzureExportBucket' to the response body 'oneOf' list for the response", + "changeCode": "response-body-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed the required property 'iamRoleId' from the response", + "changeCode": "response-required-property-removed", + "backwardCompatible": false + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "operationId": "listClusters", + "tag": "Clusters", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, results/items/replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/diskSizeGB, results/items/replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "operationId": "getCluster", + "tag": "Clusters", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "DELETE", + "operationId": "deleteAllBackupSchedules", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "GET", + "operationId": "getBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "PATCH", + "operationId": "updateBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new required request property 'copySettings/items/zoneId'", + "changeCode": "new-required-request-property", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'copySettings/items/replicationSpecId, deleteCopiedBackups/items/replicationSpecId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "GET", + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment", + "httpMethod": "POST", + "operationId": "createAtlasSearchDeployment", + "tag": "Atlas Search", + "changes": [ + { + "change": "removed the success response with the status '200'", + "changeCode": "response-success-status-removed", + "backwardCompatible": false + }, + { + "change": "added the success response with the status '201'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexesCluster", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes", + "httpMethod": "POST", + "operationId": "createAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}", + "httpMethod": "GET", + "operationId": "listAtlasSearchIndexes", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndexByName", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "DELETE", + "operationId": "deleteAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "GET", + "operationId": "getAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}", + "httpMethod": "PATCH", + "operationId": "updateAtlasSearchIndex", + "tag": "Atlas Search", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations", + "httpMethod": "POST", + "operationId": "createPushMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/liveMigrations/validate", + "httpMethod": "POST", + "operationId": "validateMigration", + "tag": "Cloud Migration Service", + "changes": [ + { + "change": "added the new optional request property 'dropDestinationData'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "removed the request property 'dropEnabled'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "httpMethod": "POST", + "operationId": "createStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "operationId": "deleteStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "operationId": "getStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "operationId": "startStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "operationId": "stopStreamProcessor", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "operationId": "listStreamProcessors", + "tag": "Streams", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}:migrate", + "httpMethod": "POST", + "operationId": "migrateProjectToAnotherOrg", + "tag": "Projects", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/2024-05-30_2024-08-05.json b/tools/cli/test/data/changelog/new-version/output/2024-05-30_2024-08-05.json new file mode 100644 index 000000000..a14f4d51a --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/2024-05-30_2024-08-05.json @@ -0,0 +1,445 @@ +[ + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "operationId": "listClusters", + "tag": "Clusters", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, results/items/replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/diskSizeGB, results/items/replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "operationId": "createCluster", + "tag": "Clusters", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "operationId": "getCluster", + "tag": "Clusters", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "operationId": "updateCluster", + "tag": "Clusters", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "DELETE", + "operationId": "deleteAllBackupSchedules", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "GET", + "operationId": "getBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "PATCH", + "operationId": "updateBackupSchedule", + "tag": "Cloud Backups", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new required request property 'copySettings/items/zoneId'", + "changeCode": "new-required-request-property", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'copySettings/items/replicationSpecId, deleteCopiedBackups/items/replicationSpecId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "GET", + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ] + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ] + } +] \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/output/changelog-all.json b/tools/cli/test/data/changelog/new-version/output/changelog-all.json new file mode 100644 index 000000000..009a4bfe7 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/output/changelog-all.json @@ -0,0 +1,16095 @@ +[ + { + "date": "2024-08-08", + "paths": [ + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'results/items/replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'results/items/replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'results/items/replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, results/items/replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'results/items/diskSizeGB, results/items/replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "listClusters", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "createCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "getCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-removed", + "backwardCompatible": false + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' request property", + "changeCode": "request-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AWS' changed from '#/components/schemas/AWSRegionConfig' to '#/components/schemas/AWSRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'AZURE' changed from '#/components/schemas/AzureRegionConfig' to '#/components/schemas/AzureRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'GCP' changed from '#/components/schemas/GCPRegionConfig' to '#/components/schemas/GCPRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "mapped value for discriminator key 'TENANT' changed from '#/components/schemas/TenantRegionConfig' to '#/components/schemas/TenantRegionConfig20240805' for 'replicationSpecs/items/regionConfigs/items/' response property", + "changeCode": "response-property-discriminator-mapping-changed", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSHardwareSpec20240805, #/components/schemas/AzureHardwareSpec20240805, #/components/schemas/GCPHardwareSpec20240805, #/components/schemas/TenantHardwareSpec20240805' to the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/AWSRegionConfig20240805, #/components/schemas/AzureRegionConfig20240805, #/components/schemas/GCPRegionConfig20240805, #/components/schemas/TenantRegionConfig20240805' to the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSHardwareSpec, #/components/schemas/AzureHardwareSpec, #/components/schemas/GCPHardwareSpec, #/components/schemas/TenantHardwareSpec' from the 'replicationSpecs/items/regionConfigs/items/electableSpecs' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "removed '#/components/schemas/AWSRegionConfig, #/components/schemas/AzureRegionConfig, #/components/schemas/GCPRegionConfig, #/components/schemas/TenantRegionConfig' from the 'replicationSpecs/items/regionConfigs/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-removed", + "backwardCompatible": true + }, + { + "change": "added the optional properties 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB, replicationSpecs/items/zoneId' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional properties 'diskSizeGB, replicationSpecs/items/numShards' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'diskSizeGB, replicationSpecs/items/numShards'", + "changeCode": "request-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'replicationSpecs/items/regionConfigs/items/electableSpecs/diskSizeGB'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "updateCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "deleteAllBackupSchedules", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "getBackupSchedule", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "removed the optional write-only property 'deleteCopiedBackups/items/replicationSpecId' from the response", + "changeCode": "response-optional-write-only-property-removed", + "backwardCompatible": true + }, + { + "change": "added the required property 'copySettings/items/zoneId' to the response", + "changeCode": "response-required-property-added", + "backwardCompatible": true + }, + { + "change": "removed the optional property 'copySettings/items/replicationSpecId' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "added the new required request property 'copySettings/items/zoneId'", + "changeCode": "new-required-request-property", + "backwardCompatible": false + }, + { + "change": "removed the request properties 'copySettings/items/replicationSpecId, deleteCopiedBackups/items/replicationSpecId'", + "changeCode": "request-property-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "updateBackupSchedule", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "getClusterAdvancedConfiguration", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "removed the optional properties 'defaultReadConcern, failIndexKeyTooLong' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true + }, + { + "change": "removed the request properties 'defaultReadConcern, failIndexKeyTooLong'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "updateClusterAdvancedConfiguration", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "added the optional property 'options' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'options'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + }, + { + "change": "the 'pipeline' request property type/format changed from 'string'/'' to 'array'/''", + "changeCode": "request-property-type-changed", + "backwardCompatible": false, + "hideFromChangelog": true + }, + { + "change": "the 'pipeline' response's property type/format changed from 'string'/'' to 'array'/'' for status '200'", + "changeCode": "response-property-type-changed", + "backwardCompatible": false, + "hideFromChangelog": true + }, + { + "change": "removed the optional property 'dlq' from the response", + "changeCode": "response-optional-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + }, + { + "change": "removed the request property 'dlq'", + "changeCode": "request-property-removed", + "backwardCompatible": true, + "hideFromChangelog": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "createStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "the 'pipeline' response's property type/format changed from 'string'/'' to 'array'/'' for status '200'", + "changeCode": "response-property-type-changed", + "backwardCompatible": false, + "hideFromChangelog": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "getStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-08-05", + "changes": [ + { + "change": "the 'results/items/pipeline' response's property type/format changed from 'string'/'' to 'array'/'' for status '200'", + "changeCode": "response-property-type-changed", + "backwardCompatible": false, + "hideFromChangelog": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "listStreamProcessors", + "tag": "Streams" + } + ] + }, + { + "date": "2024-08-07", + "paths": [ + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #1: OIDC WORKFORCE]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #2: OIDC WORKLOAD]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property 'protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createIdentityProvider", + "tag": "Federated Authentication" + }, + { + "path": "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #1: SAML]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #2: OIDC WORKFORCE]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property '/oneOf[subschema #3: OIDC WORKLOAD]/protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'OIDC, SAML' enum values to the request property 'protocol'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateIdentityProvider", + "tag": "Federated Authentication" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the success response with the status '204'", + "changeCode": "response-success-status-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "addProjectApiKey", + "tag": "Programmatic API Keys" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the request optional property 'customShardKey' became read-only", + "changeCode": "request-optional-property-became-read-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'isCustomShardKeyHashed' became write-only", + "changeCode": "request-optional-property-became-write-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'isShardKeyUnique' became write-only", + "changeCode": "request-optional-property-became-write-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'numInitialChunks' became write-only", + "changeCode": "request-optional-property-became-write-only", + "backwardCompatible": true + }, + { + "change": "the request optional property 'presplitHashedZones' became write-only", + "changeCode": "request-optional-property-became-write-only", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createManagedNamespace", + "tag": "Global Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'PENDING' enum value to the 'results/items/delivery/statusName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listLegacyBackupRestoreJobs", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'PENDING' enum value to the 'results/items/delivery/statusName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'PENDING' enum value to the request property 'delivery/statusName'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createLegacyBackupRestoreJob", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'PENDING' enum value to the 'delivery/statusName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getLegacyBackupRestoreJob", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/dataFederation", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added 'azure' discriminator mapping keys to the '/items/storage/stores/items/' response property", + "changeCode": "response-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the '/items/storage/stores/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listFederatedDatabases", + "tag": "Data Federation" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/dataFederation", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' request property", + "changeCode": "request-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' response property", + "changeCode": "response-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createFederatedDatabase", + "tag": "Data Federation" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' response property", + "changeCode": "response-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getFederatedDatabase", + "tag": "Data Federation" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' request property", + "changeCode": "request-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' request property 'oneOf' list", + "changeCode": "request-property-one-of-added", + "backwardCompatible": true + }, + { + "change": "added 'azure' discriminator mapping keys to the 'storage/stores/items/' response property", + "changeCode": "response-property-discriminator-mapping-added", + "backwardCompatible": true + }, + { + "change": "added '#/components/schemas/DataLakeAzureBlobStore' to the 'storage/stores/items/' response property 'oneOf' list for the response", + "changeCode": "response-property-one-of-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateFederatedDatabase", + "tag": "Data Federation" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/encryptionAtRest", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional property 'azureKeyVault/requirePrivateNetworking' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getEncryptionAtRest", + "tag": "Encryption at Rest using Customer Key Management" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/encryptionAtRest", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional property 'azureKeyVault/requirePrivateNetworking' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'azureKeyVault/requirePrivateNetworking'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateEncryptionAtRest", + "tag": "Encryption at Rest using Customer Key Management" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/events", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'ATLAS_SQL_SCHEDULED_UPDATE_CREATED, ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED, ATLAS_SQL_SCHEDULED_UPDATE_REMOVED, INDEPENDENT_SHARD_SCALING_AVAILABLE, QUEUED_ADMIN_ACTION_CREATED' enum values to the 'results/items/oneOf[subschema #14: NDS Audits]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'CLUSTER_FCV_DOWNGRADED' enum value to the 'results/items/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #32: Version Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listProjectEvents", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/events/{eventId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'ATLAS_SQL_SCHEDULED_UPDATE_CREATED, ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED, ATLAS_SQL_SCHEDULED_UPDATE_REMOVED, INDEPENDENT_SHARD_SCALING_AVAILABLE, QUEUED_ADMIN_ACTION_CREATED' enum values to the '/oneOf[subschema #14: NDS Audits]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'CLUSTER_FCV_DOWNGRADED' enum value to the '/oneOf[subschema #1: Any Other Events]/eventTypeName/oneOf[subschema #32: Version Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getProjectEvent", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "getStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "listStreamProcessors", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/events", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'SECURITY_CONTACT_MODIFIED' enum value to the 'results/items/oneOf[subschema #8: Org Events]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listOrganizationEvents", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/events/{eventId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'SECURITY_CONTACT_MODIFIED' enum value to the '/oneOf[subschema #8: Org Events]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getOrganizationEvent", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/invoices", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new optional 'query' request parameter 'fromDate'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + }, + { + "change": "added the new optional 'query' request parameter 'orderBy'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + }, + { + "change": "added the new optional 'query' request parameter 'sortBy'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + }, + { + "change": "added the new optional 'query' request parameter 'statusNames'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + }, + { + "change": "added the new optional 'query' request parameter 'toDate'", + "changeCode": "new-optional-request-parameter", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listInvoices", + "tag": "Invoices" + } + ] + }, + { + "date": "2024-07-24", + "paths": [ + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the response properties 'results/items/bucketName, results/items/cloudProvider, results/items/iamRoleId, results/items/roleId, results/items/serviceUrl, results/items/tenantId' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listExportBuckets", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the '/bucketName' request property's maxLength was set to '63'", + "changeCode": "request-property-max-length-set", + "backwardCompatible": true + }, + { + "change": "the '/bucketName' request property's maxLength was set to '63'", + "changeCode": "request-property-max-length-set", + "backwardCompatible": true + }, + { + "change": "the '/serviceUrl' request property's maxLength was set to '55'", + "changeCode": "request-property-max-length-set", + "backwardCompatible": true + }, + { + "change": "the 'bucketName' request property's maxLength was set to '63'", + "changeCode": "request-property-max-length-set", + "backwardCompatible": true + }, + { + "change": "the response properties '/bucketName, /cloudProvider, /iamRoleId, /roleId, /serviceUrl, /tenantId, bucketName, cloudProvider' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createExportBucket", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "changed the pattern of the 'path' request parameter 'exportBucketId' from '^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,61}[a-z0-9])$' to '^([a-f0-9]{24})$'", + "changeCode": "request-parameter-pattern-changed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "deleteExportBucket", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "changed the pattern of the 'path' request parameter 'exportBucketId' from '^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,61}[a-z0-9])$' to '^([a-f0-9]{24})$'", + "changeCode": "request-parameter-pattern-changed", + "backwardCompatible": true + }, + { + "change": "the response properties '/bucketName, /cloudProvider, /iamRoleId, /roleId, /serviceUrl, /tenantId, bucketName, cloudProvider' became required", + "changeCode": "response-property-became-required", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getExportBucket", + "tag": "Cloud Backups" + } + ] + }, + { + "date": "2024-07-18", + "paths": [ + { + "path": "/api/atlas/v2/eventTypes", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional properties 'links, results, totalCount' to the response", + "changeCode": "response-optional-property-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listEventTypes", + "tag": "Events" + } + ] + }, + { + "date": "2024-07-13", + "paths": [ + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "deleteStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "startStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "stopStreamProcessor", + "tag": "Streams" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/events", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'ORG_NO_FINANCIAL_PROTECTION, ORG_UNDER_FINANCIAL_PROTECTION' enum values to the 'results/items/oneOf[subschema #8: Org Events]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listOrganizationEvents", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/orgs/{orgId}/events/{eventId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'ORG_NO_FINANCIAL_PROTECTION, ORG_UNDER_FINANCIAL_PROTECTION' enum values to the '/oneOf[subschema #8: Org Events]/eventTypeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getOrganizationEvent", + "tag": "Events" + } + ] + }, + { + "date": "2024-07-11", + "paths": [ + { + "path": "/api/atlas/v2/eventTypes", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "endpoint added", + "changeCode": "endpoint-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "release" + } + ], + "operationId": "listEventTypes", + "tag": "Events" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listAlertConfigurations", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + }, + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the enum value 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/'", + "changeCode": "request-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createAlertConfiguration", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getAlertConfiguration", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "toggleAlertConfiguration", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}", + "httpMethod": "PUT", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + }, + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the enum value 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' of the request property '/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/'", + "changeCode": "request-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateAlertConfiguration", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #14: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listAlertsByAlertConfigurationId", + "tag": "Alerts" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #14: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listAlerts", + "tag": "Alerts" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #14: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getAlert", + "tag": "Alerts" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #14: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the '/oneOf[subschema #7: Any Other Alerts]/eventTypeName/oneOf[subschema #5: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "acknowledgeAlert", + "tag": "Alerts" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE, COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS, COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE, DISK_AUTO_SCALE_INITIATED, DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL, DISK_AUTO_SCALE_OPLOG_FAIL' enum values to the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #11: NDS Auto Scaling Audit Types]/' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "removed the 'MAX_M0_CLUSTERS_PER_GROUP_EXCEEDED' enum value from the 'results/items/oneOf[subschema #1: Any Other Alert Configurations]/eventTypeName/oneOf[subschema #4: Group Event Types]/' response property", + "changeCode": "response-property-enum-value-removed", + "backwardCompatible": false + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listAlertConfigurationsByAlertId", + "tag": "Alert Configurations" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listClusters", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' request property default value '7.0' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "createCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade", + "httpMethod": "POST", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' request property default value '7.0' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "upgradeSharedCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the 'mongoDBMajorVersion' request property default value '7.0' was removed", + "changeCode": "request-property-default-value-removed", + "backwardCompatible": true + }, + { + "change": "the 'mongoDBMajorVersion' response's property default value '7.0' was removed", + "changeCode": "response-property-default-value-removed", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateCluster", + "tag": "Clusters" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "DELETE", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional write-only property 'deleteCopiedBackups/items/zoneId' to the response", + "changeCode": "response-optional-write-only-property-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "deleteAllBackupSchedules", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional write-only property 'deleteCopiedBackups/items/zoneId' to the response", + "changeCode": "response-optional-write-only-property-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getBackupSchedule", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the optional write-only property 'deleteCopiedBackups/items/zoneId' to the response", + "changeCode": "response-optional-write-only-property-added", + "backwardCompatible": true + }, + { + "change": "added the new optional request property 'deleteCopiedBackups/items/zoneId'", + "changeCode": "new-optional-request-property", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateBackupSchedule", + "tag": "Cloud Backups" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'CONFIG_SHARD_REPLICA_SET' enum value to the 'results/items/parts/items/typeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "listLegacySnapshots", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'CONFIG_SHARD_REPLICA_SET' enum value to the 'parts/items/typeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "getLegacySnapshot", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}", + "httpMethod": "PATCH", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "added the new 'CONFIG_SHARD_REPLICA_SET' enum value to the 'parts/items/typeName' response property", + "changeCode": "response-property-enum-value-added", + "backwardCompatible": true + }, + { + "change": "added the new 'CONFIG_SHARD_REPLICA_SET' enum value to the request property 'parts/items/typeName'", + "changeCode": "request-property-enum-value-added", + "backwardCompatible": true + } + ], + "stabilityLevel": "stable", + "changeType": "update" + } + ], + "operationId": "updateLegacySnapshotRetention", + "tag": "Legacy Backup" + }, + { + "path": "/api/atlas/v2/groups/{groupId}/customDBRoles/roles", + "httpMethod": "GET", + "versions": [ + { + "version": "2024-05-30", + "changes": [ + { + "change": "the '/items/inheritedRoles/items/role' response's property pattern '^\\b(?!xgen-)([0-9A-Za-z_\\-]+)\\b(? Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + }, + "patch" : { + "deprecated" : true, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "patch" : { + "deprecated" : true, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertView" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2024-10-01" + }, + "put" : { + "deprecated" : true, + "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.", + "operationId" : "updateDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-sunset" : "2024-10-01", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2024-10-01" + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedLegacyClusterView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2025-06-01" + }, + "post" : { + "deprecated" : true, + "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.", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2025-06-01" + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" : { + "delete" : { + "deprecated" : true, + "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.", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2025-06-01" + }, + "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.", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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.", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2025-06-01" + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" : { + "delete" : { + "deprecated" : true, + "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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "patch" : { + "deprecated" : true, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "deprecated" : true, + "description" : "Returns 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 Read Only role.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2025-06-01" + }, + "post" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ], + "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" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2025-06-01" + }, + "post" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2025-06-01" + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "deprecated" : true, + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "get" : { + "deprecated" : true, + "description" : "Return the Search Nodes for the specified cluster.", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the Search Nodes for the specified cluster.", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" : { + "get" : { + "deprecated" : true, + "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\".", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ], + "x-sunset" : "2025-06-01" + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "deprecated" : true, + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster.", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20240805" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20240805", + "AZURE" : "#/components/schemas/AzureRegionConfig20240805", + "GCP" : "#/components/schemas/GCPRegionConfig20240805", + "TENANT" : "#/components/schemas/TenantRegionConfig20240805" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20240805" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20240805" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20240805" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20240805" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20240805" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20240805" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20240805" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20240805" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20240805" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20240805" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20240805" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20240805" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsOptions" : { + "type" : "object", + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + } + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/revision/openapi-2023-02-01.json b/tools/cli/test/data/changelog/new-version/revision/openapi-2023-02-01.json new file mode 100644 index 000000000..0b538f016 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/revision/openapi-2023-02-01.json @@ -0,0 +1,50090 @@ +{ + "openapi" : "3.0.1", + "info" : { + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\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\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "license" : { + "name" : "CC BY-NC-SA 3.0 US", + "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + }, + "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "title" : "MongoDB Atlas Administration API", + "version" : "2.0", + "x-xgen-sha" : "e624d716e86f6910757b60cefdf3aa3181582d38" + }, + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "tags" : [ { + "description" : "Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.", + "name" : "Access Tracking" + }, { + "description" : "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.", + "name" : "Alert Configurations" + }, { + "description" : "Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.", + "name" : "Alerts" + }, { + "description" : "Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.", + "name" : "Atlas Search" + }, { + "description" : "Returns and edits database auditing settings for MongoDB Cloud projects.", + "name" : "Auditing" + }, { + "description" : "Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.", + "name" : "AWS Clusters DNS" + }, { + "description" : "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.", + "name" : "Cloud Backups" + }, { + "description" : "Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.", + "name" : "Cloud Migration Service" + }, { + "description" : "Returns, adds, authorizes, and removes AWS IAM roles in Atlas.", + "name" : "Cloud Provider Access" + }, { + "description" : "Returns, starts, or ends a cluster outage simulation.", + "name" : "Cluster Outage Simulation" + }, { + "description" : "Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.", + "name" : "Clusters" + }, { + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.", + "name" : "Collection Level Metrics" + }, { + "description" : "Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.", + "name" : "Custom Database Roles" + }, { + "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", + "name" : "Data Federation" + }, { + "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "name" : "Data Lake Pipelines" + }, { + "description" : "Returns, adds, edits, and removes database users.", + "name" : "Database Users" + }, { + "description" : "Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "name" : "Encryption at Rest using Customer Key Management" + }, { + "description" : "Returns events. This collection remains under revision and may change.", + "name" : "Events" + }, { + "description" : "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.", + "name" : "Federated Authentication" + }, { + "description" : "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.\nMongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.", + "name" : "Global Clusters" + }, { + "description" : "Returns invoices.", + "name" : "Invoices" + }, { + "description" : "Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.", + "name" : "LDAP Configuration" + }, { + "description" : "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.", + "name" : "Legacy Backup" + }, { + "description" : "Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.", + "name" : "Maintenance Windows" + }, { + "description" : "Returns, adds, and edits MongoDB Cloud users.", + "name" : "MongoDB Cloud Users" + }, { + "description" : "Returns database deployment monitoring and logging data.", + "name" : "Monitoring and Logs" + }, { + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.", + "name" : "Network Peering" + }, { + "description" : "Returns, adds, edits, or removes an online archive.", + "name" : "Online Archive" + }, { + "description" : "Returns, adds, and edits organizational units in MongoDB Cloud.", + "name" : "Organizations" + }, { + "description" : "Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.", + "name" : "Performance Advisor" + }, { + "description" : "Returns, adds, edits, and removes private endpoint services.", + "name" : "Private Endpoint Services" + }, { + "description" : "Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.", + "name" : "Programmatic API Keys" + }, { + "description" : "Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.", + "name" : "Project IP Access List" + }, { + "description" : "Returns, adds, and edits collections of clusters and users in MongoDB Cloud.", + "name" : "Projects" + }, { + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", + "name" : "Push-Based Log Export" + }, { + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", + "name" : "Rolling Index" + }, { + "description" : "Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.", + "name" : "Root" + }, { + "description" : "Returns, adds, edits, and removes serverless instances.", + "name" : "Serverless Instances" + }, { + "description" : "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "name" : "Serverless Private Endpoints" + }, { + "description" : "Returns and adds restore jobs for shared-tier database deployments.", + "name" : "Shared-Tier Restore Jobs" + }, { + "description" : "Returns and requests to download shared-tier database deployment snapshots.", + "name" : "Shared-Tier Snapshots" + }, { + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.", + "name" : "Streams" + }, { + "description" : "Returns, adds, edits, or removes teams.", + "name" : "Teams" + }, { + "description" : "Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.\n\n**IMPORTANT**: Each project can only have one configuration per integrationType.", + "name" : "Third-Party Integrations" + }, { + "description" : "Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.", + "externalDocs" : { + "description" : "Self-Managed X.509 Certificates", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/" + }, + "name" : "X.509 Authentication" + } ], + "paths" : { + "/api/atlas/v2" : { + "get" : { + "description" : "This resource returns information about the MongoDB application along with API key meta data.", + "operationId" : "getSystemStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized." + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the status of this MongoDB application", + "tags" : [ "Root" ] + } + }, + "/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.", + "operationId" : "listAlertConfigurationMatchersFieldNames", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get All Alert Configuration Matchers Field Names", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "operationId" : "listClustersForAllProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Authorized Clusters in All Projects", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/eventTypes" : { + "get" : { + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "List All Possible Event Types", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "deleteFederationApp", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Federation Settings Instance", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connected Org Configs from One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "description" : "The connected organization configuration that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listRoleMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Role Mappings from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Role Mapping to One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "deleteRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Role Mapping in One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listIdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "The protocols of the target identity providers.", + "in" : "query", + "name" : "protocol", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "description" : "The types of the target identity providers.", + "in" : "query", + "name" : "idpType", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + } + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Identity Providers in One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + }, + "patch" : { + "deprecated" : true, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Adds one MongoDB Cloud user to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "204" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One MongoDB Cloud User to One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "patch" : { + "deprecated" : true, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertView" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2024-10-01" + }, + "put" : { + "deprecated" : true, + "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.", + "operationId" : "updateDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-sunset" : "2024-10-01", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2024-10-01" + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters" : { + "get" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAdvancedClusterDescriptionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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}", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" : { + "delete" : { + "deprecated" : true, + "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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "patch" : { + "deprecated" : true, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "deprecated" : true, + "description" : "Returns 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 Read Only role. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" : { + "delete" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-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. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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}", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "deprecated" : true, + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "get" : { + "deprecated" : true, + "description" : "Return the Search Nodes for the specified cluster.", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the Search Nodes for the specified cluster.", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "deprecated" : true, + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster.", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to create one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20240805" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20240805", + "AZURE" : "#/components/schemas/AzureRegionConfig20240805", + "GCP" : "#/components/schemas/GCPRegionConfig20240805", + "TENANT" : "#/components/schemas/TenantRegionConfig20240805" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20240805" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20240805" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20240805" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20240805" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20240805" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20240805" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20240805" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20240805" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20240805" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20240805" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20240805" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20240805" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsOptions" : { + "type" : "object", + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + } + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/revision/openapi-2023-10-01.json b/tools/cli/test/data/changelog/new-version/revision/openapi-2023-10-01.json new file mode 100644 index 000000000..4367e56d5 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/revision/openapi-2023-10-01.json @@ -0,0 +1,50085 @@ +{ + "openapi" : "3.0.1", + "info" : { + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\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\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "license" : { + "name" : "CC BY-NC-SA 3.0 US", + "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + }, + "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "title" : "MongoDB Atlas Administration API", + "version" : "2.0", + "x-xgen-sha" : "e624d716e86f6910757b60cefdf3aa3181582d38" + }, + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "tags" : [ { + "description" : "Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.", + "name" : "Access Tracking" + }, { + "description" : "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.", + "name" : "Alert Configurations" + }, { + "description" : "Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.", + "name" : "Alerts" + }, { + "description" : "Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.", + "name" : "Atlas Search" + }, { + "description" : "Returns and edits database auditing settings for MongoDB Cloud projects.", + "name" : "Auditing" + }, { + "description" : "Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.", + "name" : "AWS Clusters DNS" + }, { + "description" : "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.", + "name" : "Cloud Backups" + }, { + "description" : "Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.", + "name" : "Cloud Migration Service" + }, { + "description" : "Returns, adds, authorizes, and removes AWS IAM roles in Atlas.", + "name" : "Cloud Provider Access" + }, { + "description" : "Returns, starts, or ends a cluster outage simulation.", + "name" : "Cluster Outage Simulation" + }, { + "description" : "Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.", + "name" : "Clusters" + }, { + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.", + "name" : "Collection Level Metrics" + }, { + "description" : "Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.", + "name" : "Custom Database Roles" + }, { + "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", + "name" : "Data Federation" + }, { + "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "name" : "Data Lake Pipelines" + }, { + "description" : "Returns, adds, edits, and removes database users.", + "name" : "Database Users" + }, { + "description" : "Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "name" : "Encryption at Rest using Customer Key Management" + }, { + "description" : "Returns events. This collection remains under revision and may change.", + "name" : "Events" + }, { + "description" : "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.", + "name" : "Federated Authentication" + }, { + "description" : "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.\nMongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.", + "name" : "Global Clusters" + }, { + "description" : "Returns invoices.", + "name" : "Invoices" + }, { + "description" : "Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.", + "name" : "LDAP Configuration" + }, { + "description" : "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.", + "name" : "Legacy Backup" + }, { + "description" : "Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.", + "name" : "Maintenance Windows" + }, { + "description" : "Returns, adds, and edits MongoDB Cloud users.", + "name" : "MongoDB Cloud Users" + }, { + "description" : "Returns database deployment monitoring and logging data.", + "name" : "Monitoring and Logs" + }, { + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.", + "name" : "Network Peering" + }, { + "description" : "Returns, adds, edits, or removes an online archive.", + "name" : "Online Archive" + }, { + "description" : "Returns, adds, and edits organizational units in MongoDB Cloud.", + "name" : "Organizations" + }, { + "description" : "Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.", + "name" : "Performance Advisor" + }, { + "description" : "Returns, adds, edits, and removes private endpoint services.", + "name" : "Private Endpoint Services" + }, { + "description" : "Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.", + "name" : "Programmatic API Keys" + }, { + "description" : "Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.", + "name" : "Project IP Access List" + }, { + "description" : "Returns, adds, and edits collections of clusters and users in MongoDB Cloud.", + "name" : "Projects" + }, { + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", + "name" : "Push-Based Log Export" + }, { + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", + "name" : "Rolling Index" + }, { + "description" : "Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.", + "name" : "Root" + }, { + "description" : "Returns, adds, edits, and removes serverless instances.", + "name" : "Serverless Instances" + }, { + "description" : "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "name" : "Serverless Private Endpoints" + }, { + "description" : "Returns and adds restore jobs for shared-tier database deployments.", + "name" : "Shared-Tier Restore Jobs" + }, { + "description" : "Returns and requests to download shared-tier database deployment snapshots.", + "name" : "Shared-Tier Snapshots" + }, { + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.", + "name" : "Streams" + }, { + "description" : "Returns, adds, edits, or removes teams.", + "name" : "Teams" + }, { + "description" : "Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.\n\n**IMPORTANT**: Each project can only have one configuration per integrationType.", + "name" : "Third-Party Integrations" + }, { + "description" : "Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.", + "externalDocs" : { + "description" : "Self-Managed X.509 Certificates", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/" + }, + "name" : "X.509 Authentication" + } ], + "paths" : { + "/api/atlas/v2" : { + "get" : { + "description" : "This resource returns information about the MongoDB application along with API key meta data.", + "operationId" : "getSystemStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized." + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the status of this MongoDB application", + "tags" : [ "Root" ] + } + }, + "/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.", + "operationId" : "listAlertConfigurationMatchersFieldNames", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get All Alert Configuration Matchers Field Names", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "operationId" : "listClustersForAllProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Authorized Clusters in All Projects", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/eventTypes" : { + "get" : { + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "List All Possible Event Types", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "deleteFederationApp", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Federation Settings Instance", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connected Org Configs from One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "description" : "The connected organization configuration that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listRoleMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Role Mappings from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Role Mapping to One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "deleteRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Role Mapping in One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listIdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "The protocols of the target identity providers.", + "in" : "query", + "name" : "protocol", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "description" : "The types of the target identity providers.", + "in" : "query", + "name" : "idpType", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + } + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Identity Providers in One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + }, + "patch" : { + "deprecated" : true, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ], + "x-sunset" : "2025-01-01" + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Adds one MongoDB Cloud user to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "204" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One MongoDB Cloud User to One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "patch" : { + "deprecated" : true, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertView" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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}", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters" : { + "get" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAdvancedClusterDescriptionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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}", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" : { + "delete" : { + "deprecated" : true, + "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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "patch" : { + "deprecated" : true, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "deprecated" : true, + "description" : "Returns 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 Read Only role. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" : { + "delete" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-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. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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}", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "deprecated" : true, + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "get" : { + "deprecated" : true, + "description" : "Return the Search Nodes for the specified cluster.", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the Search Nodes for the specified cluster.", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "deprecated" : true, + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster.", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to create one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20240805" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20240805", + "AZURE" : "#/components/schemas/AzureRegionConfig20240805", + "GCP" : "#/components/schemas/GCPRegionConfig20240805", + "TENANT" : "#/components/schemas/TenantRegionConfig20240805" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20240805" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20240805" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20240805" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20240805" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20240805" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20240805" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20240805" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20240805" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20240805" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20240805" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20240805" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20240805" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsOptions" : { + "type" : "object", + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + } + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/revision/openapi-2023-11-15.json b/tools/cli/test/data/changelog/new-version/revision/openapi-2023-11-15.json new file mode 100644 index 000000000..faf226006 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/revision/openapi-2023-11-15.json @@ -0,0 +1,50809 @@ +{ + "openapi" : "3.0.1", + "info" : { + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\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\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "license" : { + "name" : "CC BY-NC-SA 3.0 US", + "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + }, + "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "title" : "MongoDB Atlas Administration API", + "version" : "2.0", + "x-xgen-sha" : "e624d716e86f6910757b60cefdf3aa3181582d38" + }, + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "tags" : [ { + "description" : "Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.", + "name" : "Access Tracking" + }, { + "description" : "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.", + "name" : "Alert Configurations" + }, { + "description" : "Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.", + "name" : "Alerts" + }, { + "description" : "Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.", + "name" : "Atlas Search" + }, { + "description" : "Returns and edits database auditing settings for MongoDB Cloud projects.", + "name" : "Auditing" + }, { + "description" : "Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.", + "name" : "AWS Clusters DNS" + }, { + "description" : "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.", + "name" : "Cloud Backups" + }, { + "description" : "Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.", + "name" : "Cloud Migration Service" + }, { + "description" : "Returns, adds, authorizes, and removes AWS IAM roles in Atlas.", + "name" : "Cloud Provider Access" + }, { + "description" : "Returns, starts, or ends a cluster outage simulation.", + "name" : "Cluster Outage Simulation" + }, { + "description" : "Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.", + "name" : "Clusters" + }, { + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.", + "name" : "Collection Level Metrics" + }, { + "description" : "Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.", + "name" : "Custom Database Roles" + }, { + "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", + "name" : "Data Federation" + }, { + "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "name" : "Data Lake Pipelines" + }, { + "description" : "Returns, adds, edits, and removes database users.", + "name" : "Database Users" + }, { + "description" : "Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "name" : "Encryption at Rest using Customer Key Management" + }, { + "description" : "Returns events. This collection remains under revision and may change.", + "name" : "Events" + }, { + "description" : "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.", + "name" : "Federated Authentication" + }, { + "description" : "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.\nMongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.", + "name" : "Global Clusters" + }, { + "description" : "Returns invoices.", + "name" : "Invoices" + }, { + "description" : "Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.", + "name" : "LDAP Configuration" + }, { + "description" : "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.", + "name" : "Legacy Backup" + }, { + "description" : "Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.", + "name" : "Maintenance Windows" + }, { + "description" : "Returns, adds, and edits MongoDB Cloud users.", + "name" : "MongoDB Cloud Users" + }, { + "description" : "Returns database deployment monitoring and logging data.", + "name" : "Monitoring and Logs" + }, { + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.", + "name" : "Network Peering" + }, { + "description" : "Returns, adds, edits, or removes an online archive.", + "name" : "Online Archive" + }, { + "description" : "Returns, adds, and edits organizational units in MongoDB Cloud.", + "name" : "Organizations" + }, { + "description" : "Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.", + "name" : "Performance Advisor" + }, { + "description" : "Returns, adds, edits, and removes private endpoint services.", + "name" : "Private Endpoint Services" + }, { + "description" : "Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.", + "name" : "Programmatic API Keys" + }, { + "description" : "Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.", + "name" : "Project IP Access List" + }, { + "description" : "Returns, adds, and edits collections of clusters and users in MongoDB Cloud.", + "name" : "Projects" + }, { + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", + "name" : "Push-Based Log Export" + }, { + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", + "name" : "Rolling Index" + }, { + "description" : "Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.", + "name" : "Root" + }, { + "description" : "Returns, adds, edits, and removes serverless instances.", + "name" : "Serverless Instances" + }, { + "description" : "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "name" : "Serverless Private Endpoints" + }, { + "description" : "Returns and adds restore jobs for shared-tier database deployments.", + "name" : "Shared-Tier Restore Jobs" + }, { + "description" : "Returns and requests to download shared-tier database deployment snapshots.", + "name" : "Shared-Tier Snapshots" + }, { + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.", + "name" : "Streams" + }, { + "description" : "Returns, adds, edits, or removes teams.", + "name" : "Teams" + }, { + "description" : "Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.\n\n**IMPORTANT**: Each project can only have one configuration per integrationType.", + "name" : "Third-Party Integrations" + }, { + "description" : "Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.", + "externalDocs" : { + "description" : "Self-Managed X.509 Certificates", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/" + }, + "name" : "X.509 Authentication" + } ], + "paths" : { + "/api/atlas/v2" : { + "get" : { + "description" : "This resource returns information about the MongoDB application along with API key meta data.", + "operationId" : "getSystemStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized." + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the status of this MongoDB application", + "tags" : [ "Root" ] + } + }, + "/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.", + "operationId" : "listAlertConfigurationMatchersFieldNames", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get All Alert Configuration Matchers Field Names", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "operationId" : "listClustersForAllProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Authorized Clusters in All Projects", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/eventTypes" : { + "get" : { + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "List All Possible Event Types", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "deleteFederationApp", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Federation Settings Instance", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connected Org Configs from One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "description" : "The connected organization configuration that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listRoleMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Role Mappings from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Role Mapping to One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "deleteRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Role Mapping in One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listIdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "The protocols of the target identity providers.", + "in" : "query", + "name" : "protocol", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "description" : "The types of the target identity providers.", + "in" : "query", + "name" : "idpType", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + } + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Identity Providers in One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: This resource only supports the creation of OIDC identity providers.", + "operationId" : "createIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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/).", + "operationId" : "deleteIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Identity Provider", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. Deprecated versions: v2-{2023-01-01}", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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).", + "operationId" : "revokeJwksFromIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke the JWKS from One OIDC Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Adds one MongoDB Cloud user to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "204" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One MongoDB Cloud User to One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "patch" : { + "deprecated" : true, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertView" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { + "get" : { + "deprecated" : true, + "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.", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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.", + "operationId" : "getExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-05-30" + } + }, + "/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}", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters" : { + "get" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAdvancedClusterDescriptionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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}", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" : { + "delete" : { + "deprecated" : true, + "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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "patch" : { + "deprecated" : true, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getPinnedNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve pinned namespaces for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pin Namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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", + "operationId" : "unpinNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to unpin namespaces from.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unpin namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "deprecated" : true, + "description" : "Returns 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 Read Only role. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" : { + "delete" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-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. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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}", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "deprecated" : true, + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "get" : { + "deprecated" : true, + "description" : "Return the Search Nodes for the specified cluster.", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the Search Nodes for the specified cluster.", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Cluster", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceClusterMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve metrics for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "explode" : true, + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given cluster", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyCluster" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Cluster-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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}", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all metric names", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "deprecated" : true, + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster.", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" : { + "post" : { + "deprecated" : true, + "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.", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-sunset" : "2025-05-30", + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ], + "x-sunset" : "2025-05-30" + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForHost", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Host", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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", + "operationId" : "getCollStatsLatencyNamespaceHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given process", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + } + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyHost" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Host-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to create one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/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).", + "operationId" : "returnAllControlPlaneIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/ControlPlaneIPAddresses" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "summary" : "Return All Control Plane IP Addresses", + "tags" : [ "Root" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20240805" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20240805", + "AZURE" : "#/components/schemas/AzureRegionConfig20240805", + "GCP" : "#/components/schemas/GCPRegionConfig20240805", + "TENANT" : "#/components/schemas/TenantRegionConfig20240805" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20240805" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20240805" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20240805" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20240805" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20240805" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20240805" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20240805" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20240805" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20240805" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20240805" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20240805" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20240805" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsOptions" : { + "type" : "object", + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + } + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/revision/openapi-2024-05-30.json b/tools/cli/test/data/changelog/new-version/revision/openapi-2024-05-30.json new file mode 100644 index 000000000..c8ae8b1bc --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/revision/openapi-2024-05-30.json @@ -0,0 +1,51949 @@ +{ + "openapi" : "3.0.1", + "info" : { + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\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\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "license" : { + "name" : "CC BY-NC-SA 3.0 US", + "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + }, + "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "title" : "MongoDB Atlas Administration API", + "version" : "2.0", + "x-xgen-sha" : "e624d716e86f6910757b60cefdf3aa3181582d38" + }, + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "tags" : [ { + "description" : "Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.", + "name" : "Access Tracking" + }, { + "description" : "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.", + "name" : "Alert Configurations" + }, { + "description" : "Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.", + "name" : "Alerts" + }, { + "description" : "Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.", + "name" : "Atlas Search" + }, { + "description" : "Returns and edits database auditing settings for MongoDB Cloud projects.", + "name" : "Auditing" + }, { + "description" : "Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.", + "name" : "AWS Clusters DNS" + }, { + "description" : "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.", + "name" : "Cloud Backups" + }, { + "description" : "Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.", + "name" : "Cloud Migration Service" + }, { + "description" : "Returns, adds, authorizes, and removes AWS IAM roles in Atlas.", + "name" : "Cloud Provider Access" + }, { + "description" : "Returns, starts, or ends a cluster outage simulation.", + "name" : "Cluster Outage Simulation" + }, { + "description" : "Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.", + "name" : "Clusters" + }, { + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.", + "name" : "Collection Level Metrics" + }, { + "description" : "Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.", + "name" : "Custom Database Roles" + }, { + "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", + "name" : "Data Federation" + }, { + "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "name" : "Data Lake Pipelines" + }, { + "description" : "Returns, adds, edits, and removes database users.", + "name" : "Database Users" + }, { + "description" : "Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "name" : "Encryption at Rest using Customer Key Management" + }, { + "description" : "Returns events. This collection remains under revision and may change.", + "name" : "Events" + }, { + "description" : "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.", + "name" : "Federated Authentication" + }, { + "description" : "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.\nMongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.", + "name" : "Global Clusters" + }, { + "description" : "Returns invoices.", + "name" : "Invoices" + }, { + "description" : "Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.", + "name" : "LDAP Configuration" + }, { + "description" : "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.", + "name" : "Legacy Backup" + }, { + "description" : "Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.", + "name" : "Maintenance Windows" + }, { + "description" : "Returns, adds, and edits MongoDB Cloud users.", + "name" : "MongoDB Cloud Users" + }, { + "description" : "Returns database deployment monitoring and logging data.", + "name" : "Monitoring and Logs" + }, { + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.", + "name" : "Network Peering" + }, { + "description" : "Returns, adds, edits, or removes an online archive.", + "name" : "Online Archive" + }, { + "description" : "Returns, adds, and edits organizational units in MongoDB Cloud.", + "name" : "Organizations" + }, { + "description" : "Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.", + "name" : "Performance Advisor" + }, { + "description" : "Returns, adds, edits, and removes private endpoint services.", + "name" : "Private Endpoint Services" + }, { + "description" : "Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.", + "name" : "Programmatic API Keys" + }, { + "description" : "Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.", + "name" : "Project IP Access List" + }, { + "description" : "Returns, adds, and edits collections of clusters and users in MongoDB Cloud.", + "name" : "Projects" + }, { + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", + "name" : "Push-Based Log Export" + }, { + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", + "name" : "Rolling Index" + }, { + "description" : "Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.", + "name" : "Root" + }, { + "description" : "Returns, adds, edits, and removes serverless instances.", + "name" : "Serverless Instances" + }, { + "description" : "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "name" : "Serverless Private Endpoints" + }, { + "description" : "Returns and adds restore jobs for shared-tier database deployments.", + "name" : "Shared-Tier Restore Jobs" + }, { + "description" : "Returns and requests to download shared-tier database deployment snapshots.", + "name" : "Shared-Tier Snapshots" + }, { + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.", + "name" : "Streams" + }, { + "description" : "Returns, adds, edits, or removes teams.", + "name" : "Teams" + }, { + "description" : "Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.\n\n**IMPORTANT**: Each project can only have one configuration per integrationType.", + "name" : "Third-Party Integrations" + }, { + "description" : "Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.", + "externalDocs" : { + "description" : "Self-Managed X.509 Certificates", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/" + }, + "name" : "X.509 Authentication" + } ], + "paths" : { + "/api/atlas/v2" : { + "get" : { + "description" : "This resource returns information about the MongoDB application along with API key meta data.", + "operationId" : "getSystemStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized." + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the status of this MongoDB application", + "tags" : [ "Root" ] + } + }, + "/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.", + "operationId" : "listAlertConfigurationMatchersFieldNames", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get All Alert Configuration Matchers Field Names", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "operationId" : "listClustersForAllProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Authorized Clusters in All Projects", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/eventTypes" : { + "get" : { + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "List All Possible Event Types", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "deleteFederationApp", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Federation Settings Instance", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connected Org Configs from One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "description" : "The connected organization configuration that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listRoleMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Role Mappings from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Role Mapping to One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "deleteRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Role Mapping in One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listIdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "The protocols of the target identity providers.", + "in" : "query", + "name" : "protocol", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "description" : "The types of the target identity providers.", + "in" : "query", + "name" : "idpType", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + } + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Identity Providers in One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: This resource only supports the creation of OIDC identity providers.", + "operationId" : "createIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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/).", + "operationId" : "deleteIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Identity Provider", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. Deprecated versions: v2-{2023-01-01}", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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).", + "operationId" : "revokeJwksFromIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke the JWKS from One OIDC Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Adds one MongoDB Cloud user to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "204" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One MongoDB Cloud User to One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "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.\n\nThis resource remains under revision and may change. Deprecated versions: v2-{2023-01-01}", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/AcknowledgeAlert" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/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}", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketsView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592" + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ], + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ], + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + } + }, + "/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}", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters" : { + "get" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAdvancedClusterDescriptionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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}", + "operationId" : "getCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "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-01-01}", + "operationId" : "updateCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" : { + "delete" : { + "deprecated" : true, + "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.", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "get" : { + "deprecated" : true, + "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.", + "operationId" : "getBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + }, + "patch" : { + "deprecated" : true, + "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.", + "operationId" : "updateBackupSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ], + "x-sunset" : "2025-08-05" + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getPinnedNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve pinned namespaces for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pin Namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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", + "operationId" : "unpinNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to unpin namespaces from.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unpin namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "deprecated" : true, + "description" : "Returns 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 Read Only role. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" : { + "delete" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-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. Deprecated versions: v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + }, + "post" : { + "deprecated" : true, + "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-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + }, + "patch" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ], + "x-sunset" : "2026-03-01" + } + }, + "/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}", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ] + }, + "get" : { + "description" : "Return the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ] + }, + "patch" : { + "description" : "Updates the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ] + }, + "post" : { + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + } + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Service Unavailable." + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Cluster", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + } + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Service Unavailable." + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the Atlas Search index to delete.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index by Name", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the Atlas Search index to return.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index by Name", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index you want to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the Atlas Search index to update.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexUpdateRequest" + } + } + }, + "description" : "Details to update the Atlas Search index with.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index By Name", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index by Id", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Service Unavailable." + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index by ID", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index you want to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexUpdateRequest" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index By ID", + "tags" : [ "Atlas Search" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Cluster", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceClusterMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve metrics for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "explode" : true, + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given cluster", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyCluster" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Cluster-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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}", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all metric names", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. Deprecated versions: v2-{2023-01-01}", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest20240530" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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}", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest20240530" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForHost", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Host", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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", + "operationId" : "getCollStatsLatencyNamespaceHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given process", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + } + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyHost" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Host-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to create one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "createStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessor" + } + } + }, + "description" : "Details to create an Atlas Streams Processor.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessor" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "deleteStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Processor", + "tags" : [ "Streams" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "startStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "stopStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Stop One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamProcessors", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsStreamProcessorWithStatsView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Stream Processors In The Stream Instance.", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "migrateProjectToAnotherOrg", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMigrationRequest" + } + } + }, + "description" : "Migrates a project from its current organization to another organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Project to Another Organization", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/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).", + "operationId" : "returnAllControlPlaneIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/ControlPlaneIPAddresses" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "summary" : "Return All Control Plane IP Addresses", + "tags" : [ "Root" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20240805" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20240805", + "AZURE" : "#/components/schemas/AzureRegionConfig20240805", + "GCP" : "#/components/schemas/GCPRegionConfig20240805", + "TENANT" : "#/components/schemas/TenantRegionConfig20240805" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20240805" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20240805" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20240805" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20240805" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20240805" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20240805" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20240805" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20240805" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20240805" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20240805" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20240805" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20240805" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsOptions" : { + "type" : "object", + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + } + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/data/changelog/new-version/revision/openapi-2024-08-05.json b/tools/cli/test/data/changelog/new-version/revision/openapi-2024-08-05.json new file mode 100644 index 000000000..1c1c4d236 --- /dev/null +++ b/tools/cli/test/data/changelog/new-version/revision/openapi-2024-08-05.json @@ -0,0 +1,51931 @@ +{ + "openapi" : "3.0.1", + "info" : { + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\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\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "license" : { + "name" : "CC BY-NC-SA 3.0 US", + "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + }, + "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "title" : "MongoDB Atlas Administration API", + "version" : "2.0", + "x-xgen-sha" : "e624d716e86f6910757b60cefdf3aa3181582d38" + }, + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "tags" : [ { + "description" : "Returns access logs for authentication attempts made to Atlas database deployments. To view database access history, you must have either the Project Owner or Organization Owner role.", + "name" : "Access Tracking" + }, { + "description" : "Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change.", + "name" : "Alert Configurations" + }, { + "description" : "Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change.", + "name" : "Alerts" + }, { + "description" : "Returns, adds, edits, and removes Atlas Search indexes for the specified cluster. Also returns and updates user-defined analyzers for the specified cluster.", + "name" : "Atlas Search" + }, { + "description" : "Returns and edits database auditing settings for MongoDB Cloud projects.", + "name" : "Auditing" + }, { + "description" : "Returns and edits custom DNS configurations for MongoDB Cloud database deployments on AWS. The resource requires your Project ID. If you use the VPC peering on AWS and you use your own DNS servers instead of Amazon Route 53, enable custom DNS. Before 31 March 2020, applications deployed within AWS using custom DNS services and VPC-peered with MongoDB Cloud couldn't connect over private IP addresses. Custom DNS resolved to public IP addresses. AWS internal DNS resolved to private IP addresses. Applications deployed with custom DNS services in AWS should use Private IP for Peering connection strings.", + "name" : "AWS Clusters DNS" + }, { + "description" : "Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.", + "name" : "Cloud Backups" + }, { + "description" : "Manages the Cloud Migration Service. Source organizations, projects, and MongoDB clusters reside on Cloud Manager or Ops Manager. Destination organizations, projects, and MongoDB clusters reside on MongoDB Cloud. Source databases can't use any authentication except SCRAM-SHA.", + "name" : "Cloud Migration Service" + }, { + "description" : "Returns, adds, authorizes, and removes AWS IAM roles in Atlas.", + "name" : "Cloud Provider Access" + }, { + "description" : "Returns, starts, or ends a cluster outage simulation.", + "name" : "Cluster Outage Simulation" + }, { + "description" : "Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.", + "name" : "Clusters" + }, { + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data.", + "name" : "Collection Level Metrics" + }, { + "description" : "Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.", + "name" : "Custom Database Roles" + }, { + "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", + "name" : "Data Federation" + }, { + "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "name" : "Data Lake Pipelines" + }, { + "description" : "Returns, adds, edits, and removes database users.", + "name" : "Database Users" + }, { + "description" : "Returns and edits the Encryption at Rest using Customer Key Management configuration. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "name" : "Encryption at Rest using Customer Key Management" + }, { + "description" : "Returns events. This collection remains under revision and may change.", + "name" : "Events" + }, { + "description" : "Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.", + "name" : "Federated Authentication" + }, { + "description" : "Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings. Each collection in a Global Cluster is associated with a managed namespace. When you create a managed namespace for a Global Cluster, MongoDB Cloud creates an empty collection for that namespace. Creating a managed namespace doesn't populate a collection with data. Similarly, deleting a managed namespace doesn't delete the associated collection.\nMongoDB Cloud shards the empty collection using the required location field and a custom shard key. For example, if your custom shard key is `city`, the compound shard key is `location, city`. Each Global Cluster is also associated with one or more Global Writes Zones. When a user creates a Global Cluster, MongoDB Cloud automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. For example, a use case might require mapping a location code to a geographically distant zone. Administrators can manage custom zone mappings with the APIs below and the **Global Cluster Configuration** pane when you create or modify your Global Cluster.", + "name" : "Global Clusters" + }, { + "description" : "Returns invoices.", + "name" : "Invoices" + }, { + "description" : "Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.", + "name" : "LDAP Configuration" + }, { + "description" : "Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.", + "name" : "Legacy Backup" + }, { + "description" : "Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.", + "name" : "Maintenance Windows" + }, { + "description" : "Returns, adds, and edits MongoDB Cloud users.", + "name" : "MongoDB Cloud Users" + }, { + "description" : "Returns database deployment monitoring and logging data.", + "name" : "Monitoring and Logs" + }, { + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen you deploy an M10+ dedicated cluster, Atlas creates a VPC for the selected provider and region or regions if no existing VPC or VPC peering connection exists for that provider and region. Atlas assigns the VPC a Classless Inter-Domain Routing (CIDR) block.", + "name" : "Network Peering" + }, { + "description" : "Returns, adds, edits, or removes an online archive.", + "name" : "Online Archive" + }, { + "description" : "Returns, adds, and edits organizational units in MongoDB Cloud.", + "name" : "Organizations" + }, { + "description" : "Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values.", + "name" : "Performance Advisor" + }, { + "description" : "Returns, adds, edits, and removes private endpoint services.", + "name" : "Private Endpoint Services" + }, { + "description" : "Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.", + "name" : "Programmatic API Keys" + }, { + "description" : "Returns, adds, edits, and removes network access limits to database deployments in Atlas. This resource replaces the whitelist resource. Atlas removed whitelists in July 2021. Update your applications to use this new resource. This resource manages a project's IP Access List and supports creating temporary Access List entries that automatically expire within a user-configurable 7-day period.", + "name" : "Project IP Access List" + }, { + "description" : "Returns, adds, and edits collections of clusters and users in MongoDB Cloud.", + "name" : "Projects" + }, { + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", + "name" : "Push-Based Log Export" + }, { + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", + "name" : "Rolling Index" + }, { + "description" : "Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.", + "name" : "Root" + }, { + "description" : "Returns, adds, edits, and removes serverless instances.", + "name" : "Serverless Instances" + }, { + "description" : "Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "name" : "Serverless Private Endpoints" + }, { + "description" : "Returns and adds restore jobs for shared-tier database deployments.", + "name" : "Shared-Tier Restore Jobs" + }, { + "description" : "Returns and requests to download shared-tier database deployment snapshots.", + "name" : "Shared-Tier Snapshots" + }, { + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID.", + "name" : "Streams" + }, { + "description" : "Returns, adds, edits, or removes teams.", + "name" : "Teams" + }, { + "description" : "Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.\n\n**IMPORTANT**: Each project can only have one configuration per integrationType.", + "name" : "Third-Party Integrations" + }, { + "description" : "Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.", + "externalDocs" : { + "description" : "Self-Managed X.509 Certificates", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/" + }, + "name" : "X.509 Authentication" + } ], + "paths" : { + "/api/atlas/v2" : { + "get" : { + "description" : "This resource returns information about the MongoDB application along with API key meta data.", + "operationId" : "getSystemStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "description" : "Unauthorized." + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the status of this MongoDB application", + "tags" : [ "Root" ] + } + }, + "/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.", + "operationId" : "listAlertConfigurationMatchersFieldNames", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get All Alert Configuration Matchers Field Names", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "operationId" : "listClustersForAllProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Authorized Clusters in All Projects", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/eventTypes" : { + "get" : { + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "List All Possible Event Types", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "deleteFederationApp", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Federation Settings Instance", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connected Org Configs from One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "description" : "The connected organization configuration that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Org Config Connected to One Federation", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listRoleMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Role Mappings from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Role Mapping to One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "deleteRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Role Mapping from One Organization", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "description" : "The role mapping that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Role Mapping in One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listIdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "The protocols of the target identity providers.", + "in" : "query", + "name" : "protocol", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "description" : "The types of the target identity providers.", + "in" : "query", + "name" : "idpType", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + } + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Identity Providers in One Federation", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: This resource only supports the creation of OIDC identity providers.", + "operationId" : "createIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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/).", + "operationId" : "deleteIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Identity Provider", + "tags" : [ "Federated Authentication" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Identity Provider by ID", + "tags" : [ "Federated Authentication" ] + }, + "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.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database. Deprecated versions: v2-{2023-01-01}", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProviderUpdate" + } + } + }, + "description" : "The identity provider that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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).", + "operationId" : "revokeJwksFromIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "No Response" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke the JWKS from One OIDC Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Metadata of One Identity Provider", + "tags" : [ "Federated Authentication" ] + } + }, + "/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.", + "operationId" : "listProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.", + "in" : "query", + "name" : "projectOwnerId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "description" : "Creates one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "getProjectByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this project.", + "in" : "path", + "name" : "groupName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project using Its Name", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "description" : "Project to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Adds one MongoDB Cloud user to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "204" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One MongoDB Cloud User to One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "createProjectIpAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } + } + } + }, + "description" : "One or more access list entries to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Entries to Project IP Access List", + "tags" : [ "Project IP Access List" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- which protocol (like TCP or UDP) the connection uses.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Entry from One Project IP Access List", + "tags" : [ "Project IP Access List" ] + }, + "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" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "getProjectIpList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (`/`) with its URL-encoded value (`%2F`).", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/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.", + "operationId" : "getProjectIpAccessListStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Network address or cloud provider security construct that identifies which project access list entry to be verified.", + "in" : "path", + "name" : "entryValue", + "required" : true, + "schema" : { + "type" : "string", + "example" : "IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})|(sg\\-[a-f0-9]{8})?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of One Project IP Access List Entry", + "tags" : [ "Project IP Access List" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations for One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "createAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Creates one alert configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" : { + "delete" : { + "description" : "Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "operationId" : "deleteAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert Configuration from One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "toggleAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "description" : "Enables or disables the specified alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle One State of One Alert Configuration in One Project", + "tags" : [ "Alert Configurations" ] + }, + "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.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "operationId" : "updateAlertConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "description" : "Updates one alert configuration in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Alert Configuration for One Project", + "tags" : [ "Alert Configurations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "description" : "Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "in" : "path", + "name" : "alertConfigId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Open Alerts for Alert Configuration", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts" : { + "get" : { + "description" : "Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlerts", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Status of the alerts to return. Omit to return all alerts in all statuses.", + "in" : "query", + "name" : "status", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alerts from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" : { + "get" : { + "description" : "Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Alert from One Project", + "tags" : [ "Alerts" ] + }, + "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.\n\nThis resource remains under revision and may change. Deprecated versions: v2-{2023-01-01}", + "operationId" : "acknowledgeAlert", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/AcknowledgeAlert" + } + } + }, + "description" : "Acknowledges or unacknowledges one alert.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Acknowledge One Alert from One Project", + "tags" : [ "Alerts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs" : { + "get" : { + "description" : "Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "in" : "path", + "name" : "alertId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Alert Configurations Set for One Alert", + "tags" : [ "Alert Configurations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listProjectApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys Assigned to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API key to be created and assigned to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create and Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "removeProjectApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unassign One Organization API Key from One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "description" : "Organization API Key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Roles of One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } + } + }, + "description" : "Organization API key to be assigned to the specified project.", + "required" : true + }, + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign One Organization API Key to One Project", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "getAuditingConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "description" : "Updated auditing configuration for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Auditing Configuration for One Project", + "tags" : [ "Auditing" ] + } + }, + "/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.", + "operationId" : "getAWSCustomDNS", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "description" : "Enables or disables the custom DNS configuration for AWS clusters in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS", + "tags" : [ "AWS Clusters DNS" ] + } + }, + "/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}", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketsView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592" + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ], + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "in" : "path", + "name" : "exportBucketId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ], + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "tags" : [ "Cloud Backups" ] + } + }, + "/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}", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.", + "in" : "query", + "name" : "overwriteBackupPolicies", + "schema" : { + "type" : "boolean", + "default" : true + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "The new Backup Compliance Policy settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listCloudProviderAccessRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Access Roles", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Creates one role for the specified cloud provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "deauthorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cloud provider of the role to deauthorize.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AWS" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deauthorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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.", + "operationId" : "getCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return specified Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + }, + "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" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "authorizeCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "in" : "path", + "name" : "roleId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + } + } + }, + "description" : "Grants access to the specified project for the specified access role.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Authorize One Cloud Provider Access Role", + "tags" : [ "Cloud Provider Access" ] + } + }, + "/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}", + "operationId" : "listClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return Clusters with retain backups.", + "in" : "query", + "name" : "includeDeletedWithRetainedBackups", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Clusters in One Project", + "tags" : [ "Clusters" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "examples" : { + "Cluster" : { + "description" : "Cluster", + "value" : "{\n \"clusterType\": \"SHARDED\",\n \"links\": [],\n \"name\": \"myCluster\",\n \"replicationSpecs\": [\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n ]\n}\n" + } + }, + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Cluster to create in the specific project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listCloudProviderRegions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.", + "in" : "query", + "name" : "providers", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "description" : "Cluster tier for which to retrieve the regions.", + "in" : "query", + "name" : "tier", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Provider Regions", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Shared-tier Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } + } + }, + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "deleteCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", + "in" : "query", + "name" : "retainBackups", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cluster from One Project", + "tags" : [ "Clusters" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Cluster to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Modify One Cluster from One Project", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listBackupExportJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getBackupExportJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique string that identifies the export job to return.", + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Snapshot Export Job", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one cluster from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job of One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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}", + "operationId" : "deleteAllBackupSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Cloud Backup Schedules", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Cloud Backup Schedule", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule20240805" + } + } + }, + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Cloud Backup Schedule for One Cluster", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Replica Set Cloud Backups", + "tags" : [ "Cloud Backups" ] + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "description" : "Takes one on-demand snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Take One On-Demand Snapshot", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteShardedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Sharded Cluster Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listShardedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Sharded Cluster Cloud Backups", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Replica Set Cloud Backup", + "tags" : [ "Cloud Backups" ] + }, + "patch" : { + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change Expiration Date for One Cloud Backup", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "Snapshot to be downloaded.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download One M2 or M5 Cluster Snapshot", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "description" : "The restore job details.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Restore Jobs" ] + } + }, + "/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.", + "operationId" : "listSharedClusterBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/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.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "tags" : [ "Shared-Tier Snapshots" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listLegacyBackupCheckpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Checkpoints", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getLegacyBackupCheckpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the checkpoint.", + "in" : "path", + "name" : "checkpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the checkpoints that you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Checkpoint", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getPinnedNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve pinned namespaces for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Pinned Namespaces", + "tags" : [ "Collection Level Metrics" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "201" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pin Namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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", + "operationId" : "unpinNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label that identifies the cluster to unpin namespaces from.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Unpin namespaces", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" : { + "post" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}" : { + "get" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" : { + "delete" : { + "deprecated" : true, + "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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "get" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + }, + "patch" : { + "deprecated" : true, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexDeprecated", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index", + "tags" : [ "Atlas Search" ], + "x-sunset" : "2025-06-01" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "description" : "Returns 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 Read Only role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteAllCustomZoneMappings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove All Custom Zone Mappings from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Custom zone mapping to add to the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "tags" : [ "Global Clusters" ] + } + }, + "/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}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "deleteManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the database that contains the collection.", + "in" : "query", + "name" : "db", + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the collection associated with the managed namespace.", + "in" : "query", + "name" : "collection", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Managed Namespace from One Global Cluster", + "tags" : [ "Global Clusters" ] + }, + "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" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Managed namespace to create within the specified global cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Managed Namespace in One Global Cluster", + "tags" : [ "Global Clusters" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Rolling Index Builds on Replica Sets", + "url" : "https://docs.mongodb.com/manual/tutorial/build-indexes-on-replica-sets/" + }, + "operationId" : "createRollingIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "2dspere Index" : { + "description" : "2dspere Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Partial Index" : { + "description" : "Partial Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "property_type" : "1" + } ], + "options" : { + "name" : "PartialIndexTest", + "partialFilterExpression" : { + "limit" : { + "$gt" : 900 + } + } + } + } + }, + "Sparse Index" : { + "description" : "Sparse Index", + "value" : { + "collation" : { + "alternate" : "non-ignorable", + "backwards" : false, + "caseFirst" : "lower", + "caseLevel" : false, + "locale" : "af", + "maxVariable" : "punct", + "normalization" : false, + "numericOrdering" : false, + "strength" : 3 + }, + "collection" : "accounts", + "db" : "sample_airbnb", + "keys" : [ { + "test_field" : "1" + } ], + "options" : { + "name" : "SparseIndexTest", + "sparse" : true + } + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/DatabaseRollingIndexRequest" + } + } + }, + "description" : "Rolling index to create on the specified cluster.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Rolling Index", + "tags" : [ "Rolling Index" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "listOnlineArchives", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Online Archives for One Cluster", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "createOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "description" : "Creates one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Online Archive", + "tags" : [ "Online Archive" ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + } + } + }, + "/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\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "downloadOnlineArchiveQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "minimum" : 1199145600 + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", + "in" : "query", + "name" : "archiveOnly", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "This resource downloads a compressed log file to your current working directory. You can specify its name using the `--output` option or use the default filename using the `-OJ` option. The default filename varies based on whether you download logs for queries of your online archive only or both your online archive and cluster." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Online Archive Query Logs", + "tags" : [ "Online Archive" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "deleteOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to delete.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "getOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to return.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Online Archive", + "tags" : [ "Online Archive" ] + }, + "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" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "updateOnlineArchive", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the online archive to update.", + "in" : "path", + "name" : "archiveId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "description" : "Updates, pauses, or resumes one online archive.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Online Archive", + "tags" : [ "Online Archive" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" : { + "delete" : { + "description" : "Ends a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "endOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "End an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "get" : { + "description" : "Returns one outage simulation for one cluster.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "getOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster that is undergoing outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + }, + "post" : { + "description" : "Starts a cluster outage simulation.", + "externalDocs" : { + "description" : "Cluster Outage Simulation", + "url" : "https://dochub.mongodb.org/core/test-regional-outage" + }, + "operationId" : "startOutageSimulation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to undergo an outage simulation.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "description" : "Describes the outage simulation.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start an Outage Simulation", + "tags" : [ "Cluster Outage Simulation" ] + } + }, + "/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}", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + }, + "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" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Advanced configuration details to add for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Advanced Configuration Options for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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}", + "operationId" : "testFailover", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Test Failover for One Cluster", + "tags" : [ "Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" : { + "get" : { + "deprecated" : true, + "description" : "Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.", + "in" : "query", + "name" : "batchId", + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Restore Jobs", + "tags" : [ "Legacy Backup" ] + }, + "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.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "description" : "Legacy backup to restore to one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}" : { + "get" : { + "deprecated" : true, + "description" : "Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "in" : "path", + "name" : "jobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Restore Job", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "delete" : { + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to delete.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Search Nodes", + "tags" : [ "Atlas Search" ] + }, + "get" : { + "description" : "Return the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Search Nodes", + "tags" : [ "Atlas Search" ] + }, + "patch" : { + "description" : "Updates the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Updates the Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Search Nodes", + "tags" : [ "Atlas Search" ] + }, + "post" : { + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Label that identifies the cluster to create Search Nodes for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "description" : "Creates Search Nodes for the specified cluster.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Search Nodes", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexesCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + } + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Service Unavailable." + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Cluster", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "createAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection on which to create an Atlas Search index.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + } + } + }, + "description" : "Creates one Atlas Search index on the specified collection.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Atlas Search Index", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "listAtlasSearchIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + } + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Service Unavailable." + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Indexes for One Collection", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the Atlas Search index to delete.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index by Name", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndexByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the Atlas Search index to return.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index by Name", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndexByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index you want to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Name of the collection that contains one or more Atlas Search indexes.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Name of the Atlas Search index to update.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexUpdateRequest" + } + } + }, + "description" : "Details to update the Atlas Search index with.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index By Name", + "tags" : [ "Atlas Search" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the database and collection with one or more Application Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Atlas Search Index by Id", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection with one or more Atlas Search indexes.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Application Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Application Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Application Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Service Unavailable." + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Atlas Search Index by ID", + "tags" : [ "Atlas Search" ] + }, + "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" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndex", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the cluster that contains the collection whose Atlas Search index you want to update.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search [index](https://dochub.mongodb.org/core/index-definitions-fts). Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", + "in" : "path", + "name" : "indexId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexUpdateRequest" + } + } + }, + "description" : "Details to update on the Atlas Search index.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Atlas Search Index By ID", + "tags" : [ "Atlas Search" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" : { + "get" : { + "deprecated" : true, + "description" : "Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.\n\n 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" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot Schedule", + "tags" : [ "Legacy Backup" ] + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\n 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" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "description" : "Update the snapshot schedule for one cluster in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Snapshot Schedule for One Cluster", + "tags" : [ "Legacy Backup" ] + } + }, + "/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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", + "in" : "query", + "name" : "completed", + "schema" : { + "type" : "string", + "default" : "true", + "enum" : [ "all", "true", "false" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Legacy Backup Snapshots", + "tags" : [ "Legacy Backup" ] + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" : { + "delete" : { + "deprecated" : true, + "description" : "Removes 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).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Legacy Backup Snapshot", + "tags" : [ "Legacy Backup" ] + }, + "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).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "tags" : [ "Legacy Backup" ] + } + }, + "/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.", + "operationId" : "getClusterStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Status of All Cluster Operations", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Cluster", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceClusterMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster to retrieve metrics for.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "in" : "path", + "name" : "clusterView", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "explode" : true, + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given cluster", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyCluster" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Cluster-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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}", + "operationId" : "getHostLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } + }, { + "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + }, { + "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespaceMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all metric names", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPeeringContainers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Container", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.", + "in" : "path", + "name" : "containerId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Updates the network details and labels of one specified network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Network Peering Container", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listCustomDatabaseRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Custom Roles in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } + } + }, + "description" : "Creates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Custom Role", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "deleteCustomDatabaseRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "No Content" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Custom Role from One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.", + "in" : "path", + "name" : "roleName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "description" : "Updates one custom role in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Custom Role in One Project", + "tags" : [ "Custom Database Roles" ] + } + }, + "/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.", + "operationId" : "listFederatedDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Type of Federated Database Instances to return.", + "in" : "query", + "name" : "type", + "schema" : { + "type" : "string", + "default" : "USER", + "enum" : [ "USER", "ONLINE_ARCHIVE" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instances in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details to create one federated database instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteFederatedDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the federated database instance to remove.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Federated Database to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.", + "in" : "query", + "name" : "skipRoleValidation", + "required" : true, + "schema" : { + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "description" : "Details of one Federated Database to update in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Federated Database Instance in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "returnFederatedDatabaseQueryLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to retrieve query limits.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Query Limits for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteOneDataFederationInstanceQueryLimit", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Query Limit For One Federated Database Instance", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance Query Limit for One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the federated database instance to which the query limit applies.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies this data federation instance limit.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "description" : "Creates or updates one query limit for one federated database instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Query Limit for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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\".", + "operationId" : "downloadFederatedDatabaseQueryLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the federated database instance for which you want to download query logs.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `queryLogs.gz` downloads" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Query Logs for One Federated Database Instance", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Database Users from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "examples" : { + "AWS IAM Authentication" : { + "description" : "AWS IAM Authentication", + "value" : { + "awsIAMType" : "USER", + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user" + } + }, + "LDAP Authentication" : { + "description" : "LDAP Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "ldapAuthType" : "GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=marketing,OU=groups,DC=example,DC=com" + } + }, + "OIDC Workforce Federated Authentication" : { + "description" : "OIDC Workforce Federated Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "IDP_GROUP", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "OIDC Workload Federated Authentication" : { + "description" : "OIDC Workload Federated Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "oidcAuthType" : "USER", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "5dd7496c7a3e5a648454341c/sales" + } + }, + "SCRAM-SHA Authentication" : { + "description" : "SCRAM-SHA Authentication", + "value" : { + "databaseName" : "admin", + "groupId" : "32b6e34b3d91647abb20e7b8", + "password" : "changeme123", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "david" + } + }, + "X509 Authentication" : { + "description" : "X509 Authentication", + "value" : { + "databaseName" : "$external", + "groupId" : "32b6e34b3d91647abb20e7b8", + "roles" : [ { + "databaseName" : "sales", + "roleName" : "readWrite" + }, { + "databaseName" : "marketing", + "roleName" : "read" + } ], + "scopes" : [ { + "name" : "myCluster", + "type" : "CLUSTER" + } ], + "username" : "CN=david@example.com,OU=users,DC=example,DC=com", + "x509Type" : "CUSTOMER" + } + } + }, + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Creates one database user in the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "deleteDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database User from One Project", + "tags" : [ "Database Users" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string", + "example" : "SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "description" : "Updates one database user that belongs to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Database User in One Project", + "tags" : [ "Database Users" ] + } + }, + "/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.", + "operationId" : "listDatabaseUserCertificates", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account whose certificates you want to return.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB User", + "tags" : [ "X.509 Authentication" ] + }, + "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.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.", + "externalDocs" : { + "description" : "Self-Managed X.509", + "url" : "https://www.mongodb.com/docs/atlas/security-self-managed-x509/#std-label-self-managed-x509" + }, + "operationId" : "createDatabaseUserCertificate", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that represents the MongoDB database user account for whom to create a certificate.", + "in" : "path", + "name" : "username", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCert" + } + } + }, + "description" : "Generates one X.509 certificate for the specified MongoDB user.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint returns a PEM file with the certificate and private key." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One X.509 Certificate for One MongoDB User", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Cluster Name", + "tags" : [ "Access Tracking" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the response returns the successful authentication attempts only.", + "in" : "query", + "name" : "authResult", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "end", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostname", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One Internet Protocol address that attempted to authenticate with the database.", + "in" : "query", + "name" : "ipAddress", + "schema" : { + "type" : "string", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.", + "in" : "query", + "name" : "start", + "schema" : { + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Database Access History for One Cluster using Its Hostname", + "tags" : [ "Access Tracking" ] + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest" : { + "get" : { + "description" : "Returns 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.\n\n**LIMITED TO M10 OR GREATER:** MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.", + "operationId" : "getEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + }, + "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.\n\n After you configure at least one Encryption at Rest using a Customer Key Management provider for the MongoDB Cloud project, Project Owners can enable Encryption at Rest using Customer Key Management for each MongoDB Cloud cluster for which they require encryption. The Encryption at Rest using Customer Key Management provider doesn't have to match the cluster cloud service provider. MongoDB Cloud doesn't automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest using Customer Key Management provider's documentation and guidance for best practices on key rotation. MongoDB Cloud automatically creates a 90-day key rotation alert when you configure Encryption at Rest using Customer Key Management using your Key Management in an MongoDB Cloud project. MongoDB Cloud encrypts all storage whether or not you use your own key management.", + "operationId" : "updateEncryptionAtRest", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "description" : "Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the **awsKms**, **azureKeyVault**, or **googleCloudKms** object to update the configuration to this endpoint.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project", + "tags" : [ "Encryption at Rest using Customer Key Management" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listProjectEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "query", + "name" : "clusterNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "style" : "form" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**IMPORTANT**: Event type names change frequently. Verify that you specify the event type correctly by checking the complete list of event types.", + "in" : "query", + "name" : "excludedEventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForNdsGroup" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Project", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/groups/{groupId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "getProjectEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Project", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "listMetricTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Metric Types for One Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Atlas Search Index Metrics for One Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getIndexMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/indexName" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the measurements that MongoDB Atlas reports for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Metrics for One Index in One Specified Namespace", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "in" : "query", + "name" : "metrics", + "required" : true, + "schema" : { + "type" : "array", + "description" : "List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.", + "items" : { + "type" : "string", + "enum" : [ "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ] + }, + "maxItems" : 10, + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Atlas Search Hardware and Status Metrics", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listThirdPartyIntegrations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Active Third-Party Service Integrations", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/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.", + "operationId" : "deleteThirdPartyIntegration", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Configure One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.", + "in" : "path", + "name" : "integrationType", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "description" : "Third-party integration that you want to configure for your project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Third-Party Service Integration", + "tags" : [ "Third-Party Integrations" ] + } + }, + "/api/atlas/v2/groups/{groupId}/invites" : { + "get" : { + "deprecated" : true, + "description" : "Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listProjectInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this project.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Invitations", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "post" : { + "deprecated" : true, + "description" : "Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Project", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { + "delete" : { + "deprecated" : true, + "description" : "Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "get" : { + "deprecated" : true, + "description" : "Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getProjectInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Invitation", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + }, + "patch" : { + "deprecated" : true, + "description" : "Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. Use the Return All Project Invitations endpoint to retrieve IDs for all pending project invitations. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectInvitationById", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Invitation by Invitation ID", + "tags" : [ "Projects" ], + "x-sunset" : "2024-10-04" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All IP Addresses for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listProjectLimits", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Limits for One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Project Limit", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Limit for One Project", + "tags" : [ "Projects" ] + }, + "patch" : { + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", + "operationId" : "setProjectLimit", + "parameters" : [ { + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "in" : "path", + "name" : "limitName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "description" : "Limit to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set One Project Limit", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations" : { + "post" : { + "description" : "Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n You can use this API endpoint for push live migrations only. Your API Key must have the Organization Owner role to successfully call this resource.\n\n **NOTE**: Migrating time-series collections is not yet supported on MongoDB 6.0 or higher. Migrations on MongoDB 6.0 or higher will skip any time-series collections on the source cluster. Deprecated versions: v2-{2023-01-01}", + "operationId" : "createPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest20240530" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "One migration to be created.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Local Managed Cluster to MongoDB Atlas", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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}", + "operationId" : "validateMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest20240530" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "One migration to be validated.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate One Migration Request", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getValidationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the validation job.", + "in" : "path", + "name" : "validationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Validation Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getPushMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Migration Job", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "cutoverMigration", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/liveMigrationId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cut Over the Migrated Cluster", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Reset One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "description" : "Updates the maintenance window for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Automatic Deferral of Maintenance for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/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.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Defer One Maintenance Window for One Project", + "tags" : [ "Maintenance Windows" ] + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Managed Slow MS enabled", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "disableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "enableSlowOperationThresholding", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable Managed Slow Operation Threshold", + "tags" : [ "Performance Advisor" ] + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Filter results to only one cloud provider.", + "in" : "query", + "name" : "cloudProvider", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "description" : "Filter results to only one instance size.", + "in" : "query", + "name" : "instanceSize", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "in" : "query", + "name" : "defaultStatus", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 100, + "example" : 100, + "minimum" : 1 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider to use for this VPC peering connection.", + "in" : "query", + "name" : "providerName", + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Connections in One Project", + "tags" : [ "Network Peering" ] + }, + "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" : { + "description" : "Azure Network Peering Prerequisites", + "url" : "https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/#prerequisites" + }, + "operationId" : "createPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Create one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "deletePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Existing Network Peering Connection", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Network Peering Connection in One Project", + "tags" : [ "Network Peering" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "in" : "path", + "name" : "peerId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "description" : "Modify one network peering connection.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One New Network Peering Connection", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipelines from One Project", + "tags" : [ "Data Lake Pipelines" ] + }, + "post" : { + "description" : "Creates one Data Lake Pipeline.", + "operationId" : "createPipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Creates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { + "delete" : { + "description" : "Removes one Data Lake Pipeline.", + "operationId" : "deletePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + }, + "patch" : { + "description" : "Updates one Data Lake Pipeline.", + "operationId" : "updatePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "description" : "Updates one Data Lake Pipeline.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSchedules", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineSnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "completedAfter", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "pausePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Pause One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "resumePipeline", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Resume One Data Lake Pipeline", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.", + "in" : "query", + "name" : "createdBefore", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2022-01-01T00:00:00Z" + } + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { + "delete" : { + "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", + "operationId" : "deletePipelineRunDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete Pipeline Run Dataset", + "tags" : [ "Data Lake Pipelines" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + }, { + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "in" : "path", + "name" : "pipelineRunId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Data Lake Pipeline Run", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { + "post" : { + "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", + "operationId" : "triggerSnapshotIngestion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "in" : "path", + "name" : "pipelineName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "description" : "Triggers a single ingestion run of a snapshot.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Trigger on demand snapshot ingestion", + "tags" : [ "Data Lake Pipelines" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Private Endpoint Concepts", + "url" : "https://dochub.mongodb.org/core/private-endpoint-concepts" + }, + "operationId" : "createPrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "getRegionalizedPrivateEndpointSetting", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + } + } + }, + "description" : "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Toggle Regionalized Private Endpoint Status", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "listServerlessPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoints for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "post" : { + "description" : "Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "deleteServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.", + "in" : "path", + "name" : "instanceName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "description" : "Object used for update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Private Endpoint for One Serverless Instance", + "tags" : [ "Serverless Private Endpoints" ] + } + }, + "/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.", + "operationId" : "listPrivateEndpointServices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Endpoint Services for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpointService", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint service.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint Service for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "createPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "description" : "Creates one private endpoint for the specified cloud service provider.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/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.", + "operationId" : "deletePrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to delete. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that manages this private endpoint.", + "in" : "path", + "name" : "cloudProvider", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, { + "description" : "Unique string that identifies the private endpoint you want to return. The format of the **endpointId** parameter differs for AWS and Azure. You must URL encode the **endpointId** for Azure private endpoints.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF][0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]resource[gG]roups%2[fF]([-\\w._()]+)%2[fF]providers%2[fF]Microsoft\\.Network%2[fF]privateEndpoints%2[fF]([-\\w._()]+)" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.", + "in" : "path", + "name" : "endpointServiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Private Endpoint for One Provider", + "tags" : [ "Private Endpoint Services" ] + } + }, + "/api/atlas/v2/groups/{groupId}/privateIpMode" : { + "get" : { + "deprecated" : true, + "description" : "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "verifyConnectViaPeeringOnlyModeForOneProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + }, + "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.", + "externalDocs" : { + "description" : "Changes to Connection Strings", + "url" : "https://docs.atlas.mongodb.com/reference/faq/connection-changes/" + }, + "operationId" : "disablePeering", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } + }, + "description" : "Disables Connect via Peering Only mode for the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Connect via Peering Only Mode for One Project", + "tags" : [ "Network Peering" ] + } + }, + "/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.", + "operationId" : "listDataFederationPrivateEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Federated Database Instance and Online Archive Private Endpoints in One Project", + "tags" : [ "Data Federation" ] + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Federated Database Instance and Online Archive Private Endpoint for One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "deleteDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Federated Database Instance and Online Archive Private Endpoint from One Project", + "tags" : [ "Data Federation" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.", + "in" : "path", + "name" : "endpointId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Federated Database Instance and Online Archive Private Endpoint in One Project", + "tags" : [ "Data Federation" ] + } + }, + "/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.", + "operationId" : "listAtlasProcesses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Processes in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getAtlasProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Process by ID", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getCollStatsLatencyNamespacesForHost", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Ranked Namespaces from a Host", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Databases for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Database for a MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "getDatabaseMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DATABASE_AVERAGE_OBJECT_SIZE", "DATABASE_COLLECTION_COUNT", "DATABASE_DATA_SIZE", "DATABASE_STORAGE_SIZE", "DATABASE_INDEX_SIZE", "DATABASE_INDEX_COUNT", "DATABASE_EXTENT_COUNT", "DATABASE_OBJECT_COUNT", "DATABASE_VIEW_COUNT" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Database for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskPartitions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Available Disks for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements" : { + "get" : { + "description" : "Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "DISK_PARTITION_IOPS_READ", "MAX_DISK_PARTITION_IOPS_READ", "DISK_PARTITION_IOPS_WRITE", "MAX_DISK_PARTITION_IOPS_WRITE", "DISK_PARTITION_IOPS_TOTAL", "MAX_DISK_PARTITION_IOPS_TOTAL", "DISK_PARTITION_LATENCY_READ", "MAX_DISK_PARTITION_LATENCY_READ", "DISK_PARTITION_LATENCY_WRITE", "MAX_DISK_PARTITION_LATENCY_WRITE", "DISK_PARTITION_SPACE_FREE", "MAX_DISK_PARTITION_SPACE_FREE", "DISK_PARTITION_SPACE_USED", "MAX_DISK_PARTITION_SPACE_USED", "DISK_PARTITION_SPACE_PERCENT_FREE", "MAX_DISK_PARTITION_SPACE_PERCENT_FREE", "DISK_PARTITION_SPACE_PERCENT_USED", "MAX_DISK_PARTITION_SPACE_PERCENT_USED" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "in" : "path", + "name" : "partitionName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements of One Disk for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements" : { + "get" : { + "description" : "Returns disk, partition, or host measurements per process for the specified host for the specified project. Returned value can be one of the following:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for `m`, repeat the `m` parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.", + "in" : "query", + "name" : "m", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "One measurement requested for this MongoDB process.", + "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE" ] + }, + "maxItems" : 10, + "minItems" : 1, + "uniqueItems" : true + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/period" + }, { + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "$ref" : "#/components/parameters/granularity" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Measurements for One MongoDB Process", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/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.", + "operationId" : "listSlowQueryNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Namespaces for One Host", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds slow queries among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve slow queries. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of lines from the log to return.", + "in" : "query", + "name" : "nLogs", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 20000, + "maximum" : 20000, + "minimum" : 0 + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the slow queries. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Slow Queries", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "listSuggestedIndexes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- If you specify neither the **duration** nor **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "duration", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as `.`: `.`. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "Maximum number of example queries that benefit from the suggested index.", + "in" : "query", + "name" : "nExamples", + "schema" : { + "type" : "integer", + "format" : "int64", + "default" : 5 + } + }, { + "description" : "Number that indicates the maximum indexes to suggest.", + "in" : "query", + "name" : "nIndexes", + "schema" : { + "type" : "integer", + "format" : "int64" + } + }, { + "description" : "Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **duration** nor the **since** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, + "/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", + "operationId" : "getCollStatsLatencyNamespaceHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "in" : "query", + "name" : "metrics", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given process", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + }, + "uniqueItems" : true + } + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyHost" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Host-Level Query Latency", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/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.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "get" : { + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get the push-based log export configuration for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "patch" : { + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + }, + "post" : { + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Enable the push-based log export feature for a project", + "tags" : [ "Push-Based Log Export" ] + } + }, + "/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.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Load Sample Dataset Request into Cluster", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "in" : "path", + "name" : "sampleDatasetId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "tags" : [ "Clusters" ] + } + }, + "/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.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Serverless Instances from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "description" : "Create One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Restore Jobs for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance whose snapshot you want to restore.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "description" : "Restores one snapshot of one serverless instance from the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Restore One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", + "in" : "path", + "name" : "restoreJobId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Restore Job for One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Snapshots of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/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.", + "operationId" : "getServerlessBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", + "in" : "path", + "name" : "snapshotId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Snapshot of One Serverless Instance", + "tags" : [ "Cloud Backups" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Serverless Auto Indexing Enabled", + "tags" : [ "Performance Advisor" ] + }, + "post" : { + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, { + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "in" : "query", + "name" : "enable", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Set Serverless Auto Indexing", + "tags" : [ "Performance Advisor" ] + } + }, + "/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.", + "operationId" : "deleteServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Serverless Instance from One Project", + "tags" : [ "Serverless Instances" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the serverless instance.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "description" : "Update One Serverless Instance in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Serverless Instance in One Project", + "tags" : [ "Serverless Instances" ] + } + }, + "/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.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "description" : "Settings to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Project Settings", + "tags" : [ "Projects" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to update.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } + }, { + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to create one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/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.", + "operationId" : "createStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessor" + } + } + }, + "description" : "Details to create an Atlas Streams Processor.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessor" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "deleteStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Stream Processor", + "tags" : [ "Streams" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Get One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "startStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Start One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "stopStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream processor.", + "in" : "path", + "name" : "processorName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Stop One Stream Processor", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listStreamProcessors", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsStreamProcessorWithStatsView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Stream Processors In The Stream Instance.", + "tags" : [ "Streams" ] + } + }, + "/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.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/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.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Verify the LDAP Configuration in One Project", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "in" : "path", + "name" : "requestId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "tags" : [ "LDAP Configuration" ] + } + }, + "/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.", + "operationId" : "listProjectUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If `\"flattenTeams\" : false`, this resource returns only users with a role in the project. If `\"flattenTeams\" : true`, this resource returns both users with roles in the project and users who belong to teams with roles in the project.", + "in" : "query", + "name" : "flattenTeams", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If `\"includeOrgUsers\": false`, this resource returns only users with a role in the project. If `\"includeOrgUsers\": true`, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.", + "in" : "query", + "name" : "includeOrgUsers", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Users in One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One User from One Project", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "migrateProjectToAnotherOrg", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMigrationRequest" + } + } + }, + "description" : "Migrates a project from its current organization to another organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Migrate One Project to Another Organization", + "tags" : [ "Projects" ] + } + }, + "/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.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organizations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" + } + } + }, + "description" : "Organization that you want to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "delete" : { + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "description" : "Details to update on the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "listApiKeys", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization API Keys", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "createApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API Key to be created.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "getApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-atlas-prog-api-key" + }, + "operationId" : "updateApiKey", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key you want to update.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "description" : "Organization API key to be updated. This request requires a minimum of one of the two body parameters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#view-the-details-of-one-api-key-in-one-organization" + }, + "operationId" : "listApiKeyAccessListsEntries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } + } + } + }, + "description" : "Access list entries to be created for the specified organization API key.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Access List Entries for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "deleteApiKeyAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + }, + "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" : { + "description" : "Configure Atlas API Access", + "url" : "https://docs.atlas.mongodb.com/configure-api-access/#std-label-enable-api-access-list" + }, + "operationId" : "getApiKeyAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.", + "in" : "path", + "name" : "apiUserId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Access List Entry for One Organization API Key", + "tags" : [ "Programmatic API Keys" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" + } + } + }, + "description" : "Filter parameters for the Cost Explorer query.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create Cost Explorer query process", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "in" : "path", + "name" : "token", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C", + "maxLength" : 64, + "minLength" : 64 + } + } ], + "responses" : { + "102" : { + "description" : "Processing" + }, + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "listOrganizationEvents", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "in" : "query", + "name" : "eventType", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EventTypeForOrg" + } + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + }, { + "description" : "Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "maxDate", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "description" : "Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.", + "in" : "query", + "name" : "minDate", + "schema" : { + "type" : "string", + "format" : "date-time", + "example" : "2021-11-17T23:15:00.06Z" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Events from One Organization", + "tags" : [ "Events" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/events/{eventId}" : { + "get" : { + "description" : "Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "operationId" : "getOrganizationEvent", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "in" : "path", + "name" : "eventId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.", + "in" : "query", + "name" : "includeRaw", + "schema" : { + "type" : "boolean", + "default" : false + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Event from One Organization", + "tags" : [ "Events" ] + } + }, + "/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.", + "operationId" : "getFederationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Federation Settings for One Organization", + "tags" : [ "Federated Authentication" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.", + "in" : "query", + "name" : "name", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One or More Projects in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "listOrganizationInvitations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.", + "in" : "query", + "name" : "username", + "schema" : { + "type" : "string", + "format" : "email" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Organization Invitations", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } + } + }, + "description" : "Invites one MongoDB Cloud user to join the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Invite One MongoDB Cloud User to Join One Atlas Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "deleteOrganizationInvitation", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Cancel One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invitation", + "tags" : [ "Organizations" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invitation.", + "in" : "path", + "name" : "invitationId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "description" : "Updates the details of one pending invitation to the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Organization Invitation by Invitation ID", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices" : { + "get" : { + "description" : "Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. 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.\nTo compute the total owed amount of the invoices - sum up total owed of each invoice. It could be computed as a sum of owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "listInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Flag that indicates whether to return linked invoices in the linkedInvoices field.", + "in" : "query", + "name" : "viewLinkedInvoices", + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, { + "description" : "Statuses of the invoice to be retrieved. Omit to return invoices of all statuses.", + "in" : "query", + "name" : "statusNames", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "uniqueItems" : true + } + }, { + "description" : "Retrieve the invoices the startDates of which are greater than or equal to the fromDate. If omit, the invoices return will go back to earliest startDate.", + "in" : "query", + "name" : "fromDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Retrieve the invoices the endDates of which are smaller than or equal to the toDate. If omit, the invoices return will go further to latest endDate.", + "in" : "query", + "name" : "toDate", + "schema" : { + "type" : "string", + "format" : "date", + "example" : "2023-01-01" + } + }, { + "description" : "Field used to sort the returned invoices by. Use in combination with orderBy parameter to control the order of the result.", + "in" : "query", + "name" : "sortBy", + "schema" : { + "type" : "string", + "default" : "END_DATE", + "enum" : [ "START_DATE", "END_DATE" ] + } + }, { + "description" : "Field used to order the returned invoices by. Use in combination of sortBy parameter to control the order of the result.", + "example" : "desc", + "in" : "query", + "name" : "orderBy", + "schema" : { + "type" : "string", + "default" : "desc", + "enum" : [ "desc", "asc" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/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.", + "operationId" : "listPendingInvoices", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Pending Invoices for One Organization", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. 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 query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "getInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n To compute the total owed amount of the invoice - sum up total owed amount of each payment included into the invoice. To compute payment's owed amount - use formula *totalBilledCents* * *unitPrice* + *salesTax* - *startingBalanceCents*.", + "operationId" : "downloadInvoiceCSV", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "[0-9a-f]+" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+csv" : { + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount\n", + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Organization Invoice as CSV", + "tags" : [ "Invoices" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { + "get" : { + "description" : "Return all projects that you can migrate to the specified organization.", + "operationId" : "listSourceProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Projects Available for Migration", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "deleteLinkToken", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Link-Token", + "tags" : [ "Cloud Migration Service" ] + }, + "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", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "description" : "IP address access list entries associated with the migration.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Link-Token", + "tags" : [ "Cloud Migration Service" ] + } + }, + "/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.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "createTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } + } + }, + "description" : "Team that you want to create in the specified organization.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Team in One Organization", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamByName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Name of the team whose information you want to return.", + "in" : "path", + "name" : "teamName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its Name", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "deleteTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to delete.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Organization", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "getTeamById", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose information you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Team using its ID", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "renameTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to rename.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "description" : "Details to update on the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Rename One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listTeamUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users Assigned to One Team", + "tags" : [ "Teams" ] + }, + "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" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } + } + } + }, + "description" : "One or more MongoDB Cloud users that you want to add to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Assign MongoDB Cloud Users from One Organization to One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeTeamUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Team", + "tags" : [ "Teams" ] + } + }, + "/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.", + "operationId" : "listOrganizationUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All MongoDB Cloud Users in One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "removeOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One MongoDB Cloud User from One Organization", + "tags" : [ "Organizations" ] + } + }, + "/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.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "description" : "Roles to update for the specified user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "tags" : [ "Organizations" ] + } + }, + "/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).", + "operationId" : "returnAllControlPlaneIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/ControlPlaneIPAddresses" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "OK" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "summary" : "Return All Control Plane IP Addresses", + "tags" : [ "Root" ] + } + }, + "/api/atlas/v2/users" : { + "post" : { + "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n MongoDB Cloud limits MongoDB Cloud user membership to a maximum of 250 MongoDB Cloud users per team. MongoDB Cloud limits MongoDB Cloud user membership to 500 MongoDB Cloud users per project and 500 MongoDB Cloud users per organization, which includes the combined membership of all projects in the organization. MongoDB Cloud raises an error if an operation exceeds these limits. For example, if you have an organization with five projects, and each project has 100 MongoDB Cloud users, and each MongoDB Cloud user belongs to only one project, you can't add any MongoDB Cloud users to this organization without first removing existing MongoDB Cloud users from the organization.\n\n To use this resource, the requesting API Key can have any role.", + "operationId" : "createUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } + }, + "description" : "MongoDB Cloud user account to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUserByUsername", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.", + "in" : "path", + "name" : "userName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Their Username", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/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.", + "operationId" : "getUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User using Its ID", + "tags" : [ "MongoDB Cloud Users" ] + } + } + }, + "components" : { + "parameters" : { + "collectionName" : { + "description" : "Human-readable label that identifies the collection.", + "in" : "path", + "name" : "collectionName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mycoll" + } + }, + "databaseName" : { + "description" : "Human-readable label that identifies the database.", + "in" : "path", + "name" : "databaseName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mydb" + } + }, + "end" : { + "description" : "Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "end", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, + "envelope" : { + "description" : "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.", + "in" : "query", + "name" : "envelope", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "federationSettingsId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your federation.", + "in" : "path", + "name" : "federationSettingsId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "55fa922fb343282757d9554e", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "granularity" : { + "description" : "Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.", + "in" : "query", + "name" : "granularity", + "required" : true, + "schema" : { + "type" : "string", + "example" : "PT1M" + } + }, + "groupId" : { + "description" : "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "in" : "path", + "name" : "groupId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "identityProviderId" : { + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "in" : "path", + "name" : "identityProviderId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + } + }, + "includeCount" : { + "description" : "Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.", + "in" : "query", + "name" : "includeCount", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : true, + "example" : true + } + }, + "indexName" : { + "description" : "Human-readable label that identifies the index.", + "in" : "path", + "name" : "indexName", + "required" : true, + "schema" : { + "type" : "string", + "example" : "myindex" + } + }, + "itemsPerPage" : { + "description" : "Number of items that the response returns per page.", + "in" : "query", + "name" : "itemsPerPage", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 100, + "example" : 100, + "maximum" : 500, + "minimum" : 1 + } + }, + "liveMigrationId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the migration.", + "in" : "path", + "name" : "liveMigrationId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "6296fb4c7c7aa997cf94e9a8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "orgId" : { + "description" : "Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.", + "in" : "path", + "name" : "orgId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "4888442a3354817a7320eb61", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "pageNum" : { + "description" : "Number of the page that displays the current set of the total objects that the response returns.", + "in" : "query", + "name" : "pageNum", + "required" : false, + "schema" : { + "type" : "integer", + "default" : 1, + "example" : 1, + "minimum" : 1 + } + }, + "period" : { + "description" : "Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set **start** and **end**.", + "in" : "query", + "name" : "period", + "required" : false, + "schema" : { + "type" : "string", + "example" : "PT10H" + } + }, + "pretty" : { + "description" : "Flag that indicates whether the response body should be in the prettyprint format.", + "in" : "query", + "name" : "pretty", + "required" : false, + "schema" : { + "type" : "boolean", + "default" : false, + "example" : false + } + }, + "processId" : { + "description" : "Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.", + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "my.host.name.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "start" : { + "description" : "Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set **period**.", + "in" : "query", + "name" : "start", + "required" : false, + "schema" : { + "type" : "string", + "format" : "date-time" + } + } + }, + "responses" : { + "accepted" : { + "description" : "Accepted." + }, + "badRequest" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.", + "error" : 400, + "errorCode" : "VALIDATION_ERROR", + "reason" : "Bad Request" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Bad Request." + }, + "conflict" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554", + "error" : 409, + "errorCode" : "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK", + "reason" : "Conflict" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Conflict." + }, + "forbidden" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 403, + "errorCode" : "CANNOT_CHANGE_GROUP_NAME", + "reason" : "Forbidden" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Forbidden." + }, + "gone" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "This happens when a resource is marked for sunset and the sunset date is in the past.", + "error" : 410, + "errorCode" : "VERSION_GONE", + "reason" : "Gone" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Gone." + }, + "internalServerError" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 500, + "errorCode" : "UNEXPECTED_ERROR", + "reason" : "Internal Server Error" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Internal Server Error." + }, + "methodNotAllowed" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 405, + "errorCode" : "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED", + "reason" : "Method Not Allowed" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Method Not Allowed." + }, + "noBody" : { + "description" : "This endpoint does not return a response body." + }, + "notFound" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS", + "error" : 404, + "errorCode" : "RESOURCE_NOT_FOUND", + "reason" : "Not Found" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Not Found." + }, + "paymentRequired" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 402, + "errorCode" : "NO_PAYMENT_INFORMATION_FOUND", + "reason" : "Payment Required" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Payment Required." + }, + "unauthorized" : { + "content" : { + "application/json" : { + "example" : { + "detail" : "(This is just an example, the exception may not be related to this endpoint)", + "error" : 401, + "errorCode" : "NOT_ORG_GROUP_CREATOR", + "reason" : "Unauthorized" + }, + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + }, + "description" : "Unauthorized." + } + }, + "schemas" : { + "AWSCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "regionName" : { + "type" : "string", + "description" : "Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "SA_EAST_1", "AP_EAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTH_1", "AP_SOUTH_2", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_CENTRAL_1", "ME_SOUTH_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the MongoDB Cloud VPC on AWS.", + "example" : "vpc-b555d3b0d9cb783b0", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "regionName" ], + "title" : "AWS" + }, + "AWSCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAWSAutoScaling" + }, + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform." + }, + "encryptEBSVolume" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled." + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "externalDocs" : { + "description" : "AWS", + "url" : "https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws" + }, + "title" : "AWS Regions" + }, + "volumeType" : { + "type" : "string", + "description" : "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title=\"Amazon Web Services\">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (`STANDARD`), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (`PROVISIONED`). You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + } + } + } ] + }, + "AWSComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + } + }, + "title" : "AWS" + }, + "AWSCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ] + } + } + } ] + }, + "AWSCustomDNSEnabledView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS).\nWhen `\"enabled\": true`, connect to your cluster using Private IP for Peering connection strings.", + "externalDocs" : { + "description" : "To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/connection-changes/#how-does-this-affect-aws-vpc-peering-when-i-use-custom-dns-" + } + } + }, + "required" : [ "enabled" ] + }, + "AWSDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_1", "US_WEST_2", "SA_EAST_1", "EU_WEST_1", "EU_WEST_2", "EU_CENTRAL_1", "AP_SOUTH_1", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2" ], + "readOnly" : true + } + } + } ] + }, + "AWSHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for nodes deployed in the region.", + "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "ebsVolumeType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Type of storage you want to attach to your AWS-provisioned cluster.\n\n- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size. \n\n- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.", + "enum" : [ "STANDARD", "PROVISIONED" ] + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + }, + "title" : "AWS Cluster Hardware Settings" + }, + "AWSInterfaceEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "connectionStatus" : { + "type" : "string", + "description" : "State of the Amazon Web Service PrivateLink connection when MongoDB Cloud received this request.", + "enum" : [ "PENDING_ACCEPTANCE", "PENDING", "AVAILABLE", "REJECTED", "DELETING" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSKMSConfiguration" : { + "type" : "object", + "description" : "Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.", + "externalDocs" : { + "description" : "Amazon Web Services Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-aws-kms/" + }, + "properties" : { + "accessKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies an Identity and Access Management (IAM) access key with permissions required to access your Amazon Web Services (AWS) Customer Master Key (CMK).", + "example" : "019dd98d94b4bb778e7552e4", + "maxLength" : 128, + "minLength" : 16 + }, + "customerMasterKeyID" : { + "type" : "string", + "description" : "Unique alphanumeric string that identifies the Amazon Web Services (AWS) Customer Master Key (CMK) you used to encrypt and decrypt the MongoDB master keys.", + "maxLength" : 2048, + "minLength" : 1 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project through Amazon Web Services (AWS) Key Management Service (KMS). To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies an Amazon Web Services (AWS) Identity and Access Management (IAM) role. This IAM role has the permissions required to manage your AWS customer master key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "secretAccessKey" : { + "type" : "string", + "description" : "Human-readable label of the Identity and Access Management (IAM) secret access key with permissions required to access your Amazon Web Services (AWS) customer master key.", + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Amazon Web Services (AWS) Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AWSPrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "interfaceEndpoints" : { + "type" : "array", + "description" : "List of strings that identify private endpoint interfaces applied to the specified project.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AWS" + }, + "AWSRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AWSRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "AWS Regional Replication Specifications" + }, + "AccessListItemView" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that found in this project's access list.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address included in the API access list.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + } + }, + "required" : [ "ipAddress" ] + }, + "AcknowledgeAlert" : { + "type" : "object", + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "title" : "Acknowledge Alert" + }, + "AddUserToTeam" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "id" ] + }, + "AdvancedAutoScalingSettings" : { + "type" : "object", + "description" : "Options that determine how this cluster handles resource scaling.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AdvancedComputeAutoScaling" + }, + "diskGB" : { + "$ref" : "#/components/schemas/DiskGBAutoScaling" + } + }, + "title" : "Automatic Scaling Settings" + }, + "AdvancedClusterDescription" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the advanced cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "AdvancedComputeAutoScaling" : { + "type" : "object", + "description" : "Options that determine how this cluster handles CPU scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "title" : "Automatic Compute Scaling Settings" + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "description" : "List that contains a document for each backup policy item in the desired backup policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + } + } + }, + "AlertAudit" : { + "type" : "object", + "description" : "Alert audit indicates acknowledgement status of an alert.", + "properties" : { + "alertId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Audits" + }, + "AlertAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "example" : "ALERT_ACKNOWLEDGED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigAudit" : { + "type" : "object", + "description" : "Alert config audit indicates any activities around alert settings.", + "properties" : { + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration associated with the **alertId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Alert Config Audits" + }, + "AlertConfigAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "example" : "ALERT_CONFIG_ADDED_AUDIT", + "title" : "Alert Audit Types" + }, + "AlertConfigView" : { + "type" : "object", + "description" : "Alert settings allows to select which conditions trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "string", + "description" : "Event type name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "notifications" ], + "title" : "Alert Configuration" + }, + "AlertMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an target instance against this alert configuration.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations." + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AlertView" : { + "type" : "object", + "description" : "Alert represents a notice of warning, a threat or a problem in the system. It can reflect a certain event or condition in the system. An Alert can be acknowledged by the user, but stays open until alert condition is resolved in the system.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "id", "status", "updated" ], + "title" : "Alert" + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DefaultAlertViewForNdsGroup" + } ] + }, + "AlertsNotificationBase" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/NDSNotificationView" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/SummaryNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsNotificationRootForGroup" : { + "type" : "object", + "description" : "One target that MongoDB Cloud sends notifications when an alert triggers.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DatadogNotification" + }, { + "$ref" : "#/components/schemas/EmailNotification" + }, { + "$ref" : "#/components/schemas/GroupNotification" + }, { + "$ref" : "#/components/schemas/HipChatNotification" + }, { + "$ref" : "#/components/schemas/MicrosoftTeamsNotification" + }, { + "$ref" : "#/components/schemas/OpsGenieNotification" + }, { + "$ref" : "#/components/schemas/OrgNotification" + }, { + "$ref" : "#/components/schemas/PagerDutyNotification" + }, { + "$ref" : "#/components/schemas/SlackNotification" + }, { + "$ref" : "#/components/schemas/SMSNotification" + }, { + "$ref" : "#/components/schemas/TeamNotification" + }, { + "$ref" : "#/components/schemas/UserNotification" + }, { + "$ref" : "#/components/schemas/VictorOpsNotification" + }, { + "$ref" : "#/components/schemas/WebhookNotification" + } ] + }, + "AlertsThresholdInteger" : { + "type" : "object", + "description" : "A Limit that triggers an alert when exceeded. The resource returns this parameter when **eventTypeName** has not been set to `OUTSIDE_METRIC_THRESHOLD`.", + "properties" : { + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "title" : "Threshold" + }, + "AlertsToggle" : { + "type" : "object", + "description" : "Enables or disables the specified alert configuration in the specified project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable or disable the specified alert configuration in the specified project." + } + }, + "title" : "Toggle Request" + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster that contains the checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "completed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the checkpoint completed and the balancer restarted. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the checkpoints.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies checkpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/ApiCheckpointPartView" + }, + "readOnly" : true + }, + "restorable" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud can use the checkpoint for a restore.", + "readOnly" : true + }, + "started" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the balancer stopped and began the checkpoint. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time to which the checkpoint restores. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" : { + "type" : "object", + "description" : "Object that contains the identifying characteristics of the Amazon Web Services (AWS) Key Management Service (KMS). This field always returns a null value.", + "nullable" : true + }, + "ApiAtlasDataLakeAWSRegionView" : { + "type" : "string", + "description" : "Atlas Data Federation AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "ApiAtlasFTSAnalyzersViewManual" : { + "type" : "object", + "description" : "Settings that describe one Atlas Search custom analyzer.", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + }, + "tokenizer" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.", + "discriminator" : { + "mapping" : { + "edgeGram" : "#/components/schemas/tokenizeredgeGram", + "keyword" : "#/components/schemas/tokenizerkeyword", + "nGram" : "#/components/schemas/tokenizernGram", + "regexCaptureGroup" : "#/components/schemas/tokenizerregexCaptureGroup", + "regexSplit" : "#/components/schemas/tokenizerregexSplit", + "standard" : "#/components/schemas/tokenizerstandard", + "uaxUrlEmail" : "#/components/schemas/tokenizeruaxUrlEmail", + "whitespace" : "#/components/schemas/tokenizerwhitespace" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/tokenizeredgeGram" + }, { + "$ref" : "#/components/schemas/tokenizerkeyword" + }, { + "$ref" : "#/components/schemas/tokenizernGram" + }, { + "$ref" : "#/components/schemas/tokenizerregexCaptureGroup" + }, { + "$ref" : "#/components/schemas/tokenizerregexSplit" + }, { + "$ref" : "#/components/schemas/tokenizerstandard" + }, { + "$ref" : "#/components/schemas/tokenizeruaxUrlEmail" + }, { + "$ref" : "#/components/schemas/tokenizerwhitespace" + } ] + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "analyzers" + }, + "ApiAtlasFTSMappingsViewManual" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts#field-mapping-examples" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "externalDocs" : { + "description" : "Atlas Search Field Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#define-field-mappings" + } + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + } + } + }, + "title" : "mappings" + }, + "ApiAtlasSnapshotScheduleView" : { + "type" : "object", + "properties" : { + "clusterCheckpointIntervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.", + "enum" : [ 15, 30, 60 ] + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "dailySnapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.", + "enum" : [ 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360 ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthlySnapshotRetentionMonths" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, 36 ] + }, + "pointInTimeWindowHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot." + }, + "snapshotIntervalHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours that must elapse before taking another snapshot.", + "enum" : [ 6, 8, 12, 24 ] + }, + "snapshotRetentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud must keep recent snapshots.", + "enum" : [ 2, 3, 4, 5 ] + }, + "weeklySnapshotRetentionWeeks" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 52 ] + } + }, + "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] + }, + "ApiBSONTimestampView" : { + "type" : "object", + "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", + "properties" : { + "date" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "increment" : { + "type" : "integer", + "format" : "int32", + "description" : "Order of the database operation that the oplog recorded at specific date and time.", + "example" : 1199145600, + "minimum" : 1199145600, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "BSON Timestamp" + }, + "ApiCheckpointPartView" : { + "type" : "object", + "description" : "Metadata contained in one document that describes the complete snapshot taken for this node.", + "properties" : { + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set to which this checkpoint applies.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard to which this checkpoint applies.", + "readOnly" : true + }, + "tokenDiscovered" : { + "type" : "boolean", + "description" : "Flag that indicates whether the token exists.", + "readOnly" : true + }, + "tokenTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of host that the part represents.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "ApiError" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "Describes the specific conditions or reasons that cause each type of error." + }, + "error" : { + "type" : "integer", + "format" : "int32", + "description" : "HTTP status code returned with this error.", + "externalDocs" : { + "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" + } + }, + "errorCode" : { + "type" : "string", + "description" : "Application error code returned with this error." + }, + "parameters" : { + "type" : "array", + "description" : "Parameters used to give more information about the error.", + "items" : { + "type" : "object" + } + }, + "reason" : { + "type" : "string", + "description" : "Application error message returned with this error." + } + } + }, + "ApiHostView_Atlas" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`).", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "lastPing" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the last ping for this MongoDB process. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "Internet Assigned Numbers Authority (IANA) port on which the MongoDB process listens for requests.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set that contains this process. This resource returns this parameter if this process belongs to a replica set.", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard that contains this process. This resource returns this value only if this process belongs to a sharded cluster.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Type of MongoDB process that MongoDB Cloud tracks. MongoDB Cloud returns new processes as **NO_DATA** until MongoDB Cloud completes deploying the process.", + "enum" : [ "REPLICA_PRIMARY", "REPLICA_SECONDARY", "RECOVERING", "SHARD_MONGOS", "SHARD_CONFIG", "SHARD_STANDALONE", "SHARD_PRIMARY", "SHARD_SECONDARY", "NO_DATA" ], + "readOnly" : true + }, + "userAlias" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster node. MongoDB Cloud sets this hostname usually to the standard hostname for the cluster node. It appears in the connection string for a cluster instead of the value of the hostname parameter.", + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "Version of MongoDB that this process runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + } + } + }, + "ApiKey" : { + "type" : "object", + "description" : "Details contained in one API key.", + "nullable" : true, + "properties" : { + "accessList" : { + "type" : "array", + "description" : "List of network addresses granted access to this API using this API key.", + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the Cloud user.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "id", "publicKey" ] + }, + "ApiKeyUserDetails" : { + "type" : "object", + "description" : "Details of the Programmatic API Keys.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this organization API key assigned to this project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "privateKey" : { + "type" : "string", + "description" : "Redacted private key returned for this organization API key. This key displays unredacted when first created.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "description" : "Public API key value set for the specified organization API key.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + } + }, + "ApiMeasurementsGeneralView_Atlas" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement_Atlas" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "ApiSearchDeploymentRequestView" : { + "type" : "object", + "properties" : { + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "maxItems" : 1, + "minItems" : 1 + } + }, + "required" : [ "specs" ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "enum" : [ "IDLE", "PAUSED", "UPDATING" ], + "readOnly" : true + } + } + }, + "ApiSearchDeploymentSpecView" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of Search Nodes in the cluster.", + "example" : 2, + "maximum" : 32, + "minimum" : 2 + } + }, + "required" : [ "instanceSize", "nodeCount" ] + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "VIRGINIA_USA" ] + }, + "ApiUserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "example" : "API_KEY_CREATED", + "title" : "API User Event Types" + }, + "ApiUserEventViewForNdsGroup" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "ApiUserEventViewForOrg" : { + "type" : "object", + "description" : "API User event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "API User Events" + }, + "AppServiceAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Alert Configuration" + }, + "AppServiceAlertView" : { + "type" : "object", + "description" : "App Services alert notifies different activities about a BAAS application.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "App Services Alerts" + }, + "AppServiceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "example" : "DEPLOYMENT_FAILURE", + "readOnly" : true, + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], + "example" : "DEPLOYMENT_FAILURE", + "title" : "App Services Event Types" + }, + "AppServiceEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_REALM_METRIC_THRESHOLD", + "title" : "App Services Event Types" + }, + "AppServiceEventView" : { + "type" : "object", + "description" : "App Services event identifies different activities about a BAAS application.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "App Services Events" + }, + "AppServiceMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "App Services Metric Alert Configuration" + }, + "AppServiceMetricMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an app service metric against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "AppServiceMetricMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "APPLICATION_ID" ], + "example" : "APPLICATION_ID", + "title" : "App Services Metric Matcher Fields" + }, + "AppServiceMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", + "discriminator" : { + "mapping" : { + "REALM_AUTH_LOGIN_FAIL" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_ENDPOINTS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_ENDPOINTS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_ENDPOINTS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_GQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_GQL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_GQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_OVERALL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_OVERALL_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDKFNS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_SDK_FNS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_FUNCTIONS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SDK_MQL_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SDK_MQL_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_BOOTSTRAP_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_CLIENT_CHANGESETS_INVALID" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_READS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CLIENT_UPLOADS_FAILED" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_SYNC_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_FAILED_REQUESTS" : "#/components/schemas/DataMetricThresholdView", + "REALM_SYNC_NUM_UNSYNCABLE_DOCS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "REALM_SYNC_SESSIONS_ENDED" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_COMPUTE_MS" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_CURRENT_OPLOG_LAG_MS_SUM" : "#/components/schemas/TimeMetricThresholdView", + "REALM_TRIGGERS_EGRESS_BYTES" : "#/components/schemas/DataMetricThresholdView", + "REALM_TRIGGERS_FAILED_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "REALM_TRIGGERS_RESPONSE_MS" : "#/components/schemas/TimeMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "App Services Metric Threshold" + }, + "AtlasClusterOutageSimulationOutageFilter" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "The cloud provider of the region that undergoes the outage simulation.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "regionName" : { + "type" : "string", + "description" : "The name of the region to undergo an outage simulation." + }, + "type" : { + "type" : "string", + "description" : "The type of cluster outage to simulate.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "AtlasOrganization" : { + "type" : "object", + "description" : "Details that describe the organization.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isDeleted" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has been deleted.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + } + }, + "required" : [ "name" ] + }, + "AtlasSearchAnalyzer" : { + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + }, + "required" : [ "name", "tokenizer" ], + "title" : "Atlas Search Analyzer" + }, + "AuditLog" : { + "type" : "object", + "properties" : { + "auditAuthorizationSuccess" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone set auditing to track successful authentications. This only applies to the `\"atype\" : \"authCheck\"` audit filter. Setting this parameter to `true` degrades cluster performance.", + "externalDocs" : { + "description" : "System Auditing Messages", + "url" : "https://docs.mongodb.com/manual/reference/audit-message/#audit-event-actions-details-and-results" + } + }, + "auditFilter" : { + "type" : "string", + "description" : "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (`\\`).", + "externalDocs" : { + "description" : "Custom Auditing Filter", + "url" : "https://docs.atlas.mongodb.com/tutorial/auditing-custom-filter/" + } + }, + "configurationType" : { + "type" : "string", + "description" : "Human-readable label that displays how to configure the audit filter.", + "enum" : [ "NONE", "FILTER_BUILDER", "FILTER_JSON" ], + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled database auditing for the specified project." + } + } + }, + "AuthFederationRoleMapping" : { + "type" : "object", + "description" : "Mapping settings that link one IdP and MongoDB Cloud.", + "properties" : { + "externalGroupName" : { + "type" : "string", + "description" : "Unique human-readable label that identifies the identity provider group to which this role mapping applies.", + "maxLength" : 200, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this role mapping.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "roleAssignments" : { + "type" : "array", + "description" : "Atlas roles and the unique identifiers of the groups and organizations associated with each role. The array must include at least one element with an Organization role and its respective **orgId**. Each element in the array can have a value for **orgId** or **groupId**, but not both.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + }, + "uniqueItems" : true + } + }, + "required" : [ "externalGroupName" ], + "title" : "Federated Authentication Role Mapping" + }, + "AutoExportPolicyView" : { + "type" : "object", + "description" : "Policy for automatically exporting Cloud Backup Snapshots.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that indicates the rate at which the export policy item occurs.", + "enum" : [ "monthly", "yearly" ] + } + }, + "title" : "export" + }, + "AutomationConfigEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "example" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", + "title" : "Automation Config Event Types" + }, + "AutomationConfigEventView" : { + "type" : "object", + "description" : "Automation config event identifies that deployment configuration is published.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Automation Config Events" + }, + "AvailableCloudProviderRegion" : { + "type" : "object", + "properties" : { + "default" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cloud provider sets this region as its default. AWS defaults to US_EAST_1, GCP defaults to CENTRAL_US, and AZURE defaults to US_WEST_2.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the supported region.", + "readOnly" : true + } + } + }, + "AvailableClustersDeployment" : { + "type" : "object", + "description" : "Deployments that can be migrated to MongoDB Atlas.", + "properties" : { + "agentVersion" : { + "type" : "string", + "description" : "Version of MongoDB Agent that monitors/manages the cluster.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dbSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Size of this database on disk at the time of the request expressed in bytes.", + "example" : 8192, + "readOnly" : true + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Version of MongoDB [features](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "example" : "Project X sharded cluster", + "readOnly" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Size of the Oplog on disk at the time of the request expressed in MB.", + "example" : 3, + "readOnly" : true + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- If `false`, this cluster serves as a replica set.", + "readOnly" : true + }, + "shardsSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of shards that comprise this cluster.", + "example" : 3, + "readOnly" : true + }, + "tlsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled TLS for this cluster.", + "readOnly" : true + } + }, + "required" : [ "featureCompatibilityVersion", "managed", "mongoDBVersion", "name", "sharded", "tlsEnabled" ], + "title" : "Available Clusters" + }, + "AwsNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "accepterRegionName" : { + "type" : "string", + "description" : "Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns `null` if your VPC and the MongoDB Cloud VPC reside in the same region." + }, + "awsAccountId" : { + "type" : "string", + "description" : "Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.", + "maxLength" : 12, + "minLength" : 12, + "pattern" : "^[0-9]{12}$" + }, + "connectionId" : { + "type" : "string", + "description" : "Unique string that identifies the peering connection on AWS.", + "readOnly" : true + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorStateName" : { + "type" : "string", + "description" : "Type of error that can be returned when requesting an Amazon Web Services (AWS) peering connection. The resource returns `null` if the request succeeded.", + "enum" : [ "REJECTED", "EXPIRED", "INVALID_ARGUMENT" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "routeTableCidrBlock" : { + "type" : "string", + "description" : "Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "statusName" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "FAILED", "FINALIZING", "AVAILABLE", "TERMINATING" ], + "readOnly" : true + }, + "vpcId" : { + "type" : "string", + "description" : "Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.", + "minLength" : 5, + "pattern" : "^vpc-[0-9a-f]{17}$" + } + }, + "required" : [ "accepterRegionName", "awsAccountId", "containerId", "routeTableCidrBlock", "vpcId" ], + "title" : "AWS" + }, + "AzureCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the `/24` and `/21` ranges.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the MongoDB Cloud VNet resides.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Azure region to which MongoDB Cloud deployed this network peering container.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_EAST_2_EUAP", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "UAE_NORTH", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure VNet in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 38, + "minLength" : 38, + "pattern" : "^([-\\w._()])+$", + "readOnly" : true + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock", "region" ], + "title" : "AZURE" + }, + "AzureCloudProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderAzureAutoScaling" + }, + "diskTypeName" : { + "type" : "string", + "description" : "Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected **providerSettings.instanceSizeName** applies.", + "enum" : [ "P2", "P3", "P4", "P6", "P10", "P15", "P20", "P30", "P40", "P50" ], + "externalDocs" : { + "description" : "Disk type", + "url" : "https://docs.microsoft.com/en-us/azure/virtual-machines/premium-storage-performance#premium-storage-disk-sizes" + } + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "externalDocs" : { + "description" : "Azure", + "url" : "https://docs.atlas.mongodb.com/reference/microsoft-azure/" + }, + "title" : "Azure Regions" + } + } + } ] + }, + "AzureComputeAutoScalingRules" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + } + }, + "title" : "Azure" + }, + "AzureCreateDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you wish to store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ] + } + } + } ] + }, + "AzureDataProcessRegionView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of the region where you store your archived data.", + "enum" : [ "US_EAST_2", "EUROPE_WEST" ], + "readOnly" : true + } + } + } ] + }, + "AzureHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "AzureKeyVault" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).", + "externalDocs" : { + "description" : "Azure Key Vault", + "url" : "https://www.mongodb.com/docs/atlas/security-azure-kms/" + }, + "properties" : { + "azureEnvironment" : { + "type" : "string", + "description" : "Azure environment in which your account credentials reside.", + "enum" : [ "AZURE", "AZURE_CHINA", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant." + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyIdentifier" : { + "type" : "string", + "description" : "Web address with a unique key that identifies for your Azure Key Vault.", + "example" : "https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86" + }, + "keyVaultName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Key Vault that contains your key." + }, + "requirePrivateNetworking" : { + "type" : "boolean", + "description" : "Enable connection to your Azure Key Vault over private networking." + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Name of the Azure resource group that contains your Azure Key Vault." + }, + "secret" : { + "type" : "string", + "description" : "Private data that you need secured and that belongs to the specified Azure Key Vault (AKV) tenant (**azureKeyVault.tenantID**). This data can include any type of sensitive data such as passwords, database connection strings, API keys, and the like. AKV stores this information as encrypted binary data.", + "externalDocs" : { + "description" : "Azure Key Vault Secrets", + "url" : "https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets" + }, + "writeOnly" : true + }, + "subscriptionID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies your Azure subscription." + }, + "tenantID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription." + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Azure encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "type" : "object", + "description" : "Azure Key Vault Encryption At Rest Private Endpoint.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Azure Key Vault EAR Private Endpoint" + }, + "AzureNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "azureDirectoryId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "azureSubscriptionId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides.", + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorState" : { + "type" : "string", + "description" : "Error message returned when a requested Azure network peering resource returns `\"status\" : \"FAILED\"`. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "resourceGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the resource group in which the VNet to peer with the MongoDB Cloud VNet resides.", + "pattern" : "^([-\\w._()])+$" + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "AVAILABLE", "FAILED", "DELETION_FAILED", "DELETING" ], + "readOnly" : true + }, + "vnetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the VNet that you want to peer with the MongoDB Cloud VNet.", + "pattern" : "^([-\\w._()])+$" + } + }, + "required" : [ "azureDirectoryId", "azureSubscriptionId", "containerId", "resourceGroupName", "vnetName" ], + "title" : "AZURE" + }, + "AzurePrivateEndpoint" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Human-readable label that MongoDB Cloud generates that identifies the private endpoint connection.", + "pattern" : "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}%2[fF]([-\\w._()]+)%2[fF]([-\\w._()]+)", + "readOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "privateEndpointResourceId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Azure Private Link Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzurePrivateLinkConnection" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "privateEndpoints" : { + "type" : "array", + "description" : "List of private endpoints assigned to this Azure Private Link Service.", + "items" : { + "type" : "string", + "description" : "Root-relative path to one private endpoint assigned to this Azure Private Link Service.", + "pattern" : "^\\/subscriptions\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\/resource[gG]roups\\/([-\\w._()]+)\\/providers\\/Microsoft\\.Network\\/privateEndpoints\\/([-\\w._()]+)", + "readOnly" : true + }, + "readOnly" : true + }, + "privateLinkServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure Private Link Service that MongoDB Cloud manages.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies of the Azure Private Link Service that MongoDB Cloud manages. Use this value to create a private endpoint connection to an Azure VNet.", + "example" : "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "AZURE" + }, + "AzureRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "AzureRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Azure Regional Replication Specifications" + }, + "BackupComplianceOnDemandPolicyItem" : { + "type" : "object", + "description" : "Specifications for on-demand policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupComplianceScheduledPolicyItem" : { + "type" : "object", + "description" : "Specifications for scheduled policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "BackupLabel" : { + "type" : "object", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes." + }, + "value" : { + "type" : "string", + "description" : "Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes." + } + } + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "readOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "readOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "readOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + } + }, + "BackupOnlineArchiveCreate" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "collName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection for which you created the online archive.", + "writeOnly" : true + }, + "collectionType" : { + "type" : "string", + "default" : "STANDARD", + "description" : "Classification of MongoDB database collection that you want to return.\n\nIf you set this parameter to `TIMESERIES`, set `\"criteria.type\" : \"date\"` and `\"criteria.dateFormat\" : \"ISODATE\"`.", + "enum" : [ "TIMESERIES", "STANDARD" ], + "writeOnly" : true + }, + "criteria" : { + "$ref" : "#/components/schemas/CriteriaView" + }, + "dataExpirationRule" : { + "$ref" : "#/components/schemas/DataExpirationRuleView" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/CreateDataProcessRegionView" + }, + "dataSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for this online archive.", + "readOnly" : true + }, + "dbName" : { + "type" : "string", + "description" : "Human-readable label of the database that contains the collection that contains the online archive.", + "writeOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the specified cluster. The specified cluster contains the collection for which to create the online archive.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "partitionFields" : { + "type" : "array", + "description" : "List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify parameters that you frequently query. If you \"specified :criteria.type\": \"DATE\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to three parameters by which to query. One of these parameters must be the DATE value, which is required in this case. If you \"specified :criteria.type\": \"CUSTOM\" in the CREATE ONE ONLINE ARCHIVE endpoint, then you can specify up to two parameters by which to query. Queries that don't use \":criteria.type\": \"DATE\" or \":criteria.type\": \"CUSTOM\" parameters cause MongoDB to scan a full collection of all archived documents. This takes more time and increases your costs.", + "items" : { + "$ref" : "#/components/schemas/PartitionFieldView" + }, + "minItems" : 1, + "writeOnly" : true + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether this online archive exists in the paused state. A request to resume fails if the collection has another active online archive. To pause an active online archive or resume a paused online archive, you must include this parameter. To pause an active archive, set this to **true**. To resume a paused archive, set this to **false**." + }, + "schedule" : { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, + "state" : { + "type" : "string", + "description" : "Phase of the process to create this online archive when you made this request.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `PAUSED` | MongoDB Cloud has stopped archiving. Archived documents can be queried. The specified archiving operation on the active cluster cannot archive additional documents. You can resume archiving for paused archives at any time. |\n| `ORPHANED` | Someone has deleted the collection associated with an active or paused archive. MongoDB Cloud doesn't delete the archived data. You must manually delete the online archives associated with the deleted collection. |\n| `DELETED` | Someone has deleted the archive was deleted. When someone deletes an online archive, MongoDB Cloud removes all associated archived documents from the cloud object storage. |", + "enum" : [ "PENDING", "ACTIVE", "PAUSING", "PAUSED", "DELETED", "ORPHANED" ], + "readOnly" : true + } + }, + "required" : [ "collName", "criteria", "dbName" ] + }, + "BackupRestoreJob" : { + "type" : "object", + "properties" : { + "batchId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "checkpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Use this parameter with sharded clusters only.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the **delivery** object.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "delivery" : { + "$ref" : "#/components/schemas/BackupRestoreJobDelivery" + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted the data in the restored snapshot.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hashes" : { + "type" : "array", + "description" : "List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `\"methodName\" : \"HTTP\"`, this list contains one object that represents the hash of the **.tar.gz** file.", + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + }, + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `\"encryptionEnabled\" : \"true\"`.", + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with **oplogTs**, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "minimum" : 1, + "writeOnly" : true + }, + "oplogTs" : { + "type" : "string", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with **oplogInc**, they represent the last database operation to which you want to restore your data. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`. Run a query against **local.oplog.rs** on your replica set to find the desired timestamp.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the **delivery** object.", + "pattern" : "^(?:[1-9]\\\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\\\d|2[0-3]):[0-5]\\\\d:[0-5]\\\\d(?:\\\\.\\\\d{1,9})?(?:Z|[+-][01]\\\\d:[0-5]\\\\d)$", + "writeOnly" : true + }, + "pointInTimeUTCMillis" : { + "type" : "integer", + "format" : "int64", + "description" : "Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the **delivery** object.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "minimum" : 1199145600000, + "writeOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "statusName" : { + "type" : "string", + "description" : "Human-readable label that identifies the status of the downloadable file at the time of the request.", + "enum" : [ "IN_PROGRESS", "BROKEN", "KILLED", "FINISHED" ], + "readOnly" : true + }, + "timestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + } + }, + "required" : [ "delivery" ] + }, + "BackupRestoreJobDelivery" : { + "type" : "object", + "description" : "Method and details that indicate how to deliver the restored snapshot data.", + "properties" : { + "authHeader" : { + "type" : "string", + "description" : "Header name to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "authValue" : { + "type" : "string", + "description" : "Header value to use when downloading the restore, used with `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "expirationHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours after the restore job completes that indicates when the Uniform Resource Locator (URL) for the snapshot download file expires. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the Uniform Resource Locator (URL) for the snapshot download file expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "maxDownloads" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that indicates how many times you can use the Uniform Resource Locator (URL) for the snapshot download file. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "minimum" : 1 + }, + "methodName" : { + "type" : "string", + "description" : "Human-readable label that identifies the means for delivering the data. If you set `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`, you must also set: **delivery.targetGroupId** and **delivery.targetClusterName** or **delivery.targetClusterId**. The response returns `\"delivery.methodName\" : \"HTTP\"` as an automated restore uses HyperText Transport Protocol (HTTP) to deliver the restore job to the target host.", + "enum" : [ "CLIENT_PIT_HTTP", "QUERY", "AUTOMATED_RESTORE", "HTTP", "THIRD_PARTY_COPY", "CLIENT_PIT_SCP", "SCP" ] + }, + "statusName" : { + "type" : "string", + "description" : "State of the downloadable snapshot file when MongoDB Cloud received this request.", + "enum" : [ "NOT_STARTED", "IN_PROGRESS", "READY", "FAILED", "INTERRUPTED", "EXPIRED", "MAX_DOWNLOADS_EXCEEDED", "PENDING" ], + "readOnly" : true + }, + "targetClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target cluster. Use the **clusterId** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster. Use the **clusterName** returned in the response body of the **Get All Snapshots** and **Get a Snapshot** endpoints. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the destination cluster for the restore job. The resource returns this parameter when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "url" : { + "type" : "string", + "deprecated" : true, + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. Url includes the verification key. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + }, + "urlV2" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) from which you can download the restored snapshot data. This should be preferred over **url**. The verification key must be sent as an HTTP header. The resource returns this parameter when `\"delivery.methodName\" : \"HTTP\"`.", + "readOnly" : true + } + }, + "required" : [ "methodName" ], + "title" : "Restore Snapshot Delivery Metadata" + }, + "BackupSnapshot" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "complete" : { + "type" : "boolean", + "description" : "Flag that indicates whether the snapshot exists. This flag returns `false` while MongoDB Cloud creates the snapshot.", + "readOnly" : true + }, + "created" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "doNotDelete" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone can delete this snapshot. You can't set `\"doNotDelete\" : true` and set a timestamp for **expires** in the same request." + }, + "expires" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. If `\"doNotDelete\" : true`, MongoDB Cloud removes any value set for this parameter." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "incremental" : { + "type" : "boolean", + "description" : "Flag indicating if this is an incremental or a full snapshot.", + "readOnly" : true + }, + "lastOplogAppliedTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "parts" : { + "type" : "array", + "description" : "Metadata that describes the complete snapshot.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + }, + "readOnly" : true + } + } + }, + "BackupSnapshotPart" : { + "type" : "object", + "description" : "Characteristics that identify this snapshot.", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the snapshots you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "compressionSetting" : { + "type" : "string", + "description" : "Human-readable label that identifies the method of compression for the snapshot.", + "enum" : [ "NONE", "GZIP" ], + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. This parameter expresses its value in bytes.", + "readOnly" : true + }, + "encryptionEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone encrypted this snapshot.", + "readOnly" : true + }, + "fileSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of the data files in bytes.", + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. The resource returns this parameter when `\"parts.encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Number that indicates the version of MongoDB that the replica set primary ran when MongoDB Cloud created the snapshot.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set.", + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number that indicates the total size of space allocated for document storage.", + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the type of server from which MongoDB Cloud took this snapshot.", + "enum" : [ "REPLICA_SET", "CONFIG_SERVER", "CONFIG_SERVER_REPLICA_SET", "CONFIG_SHARD_REPLICA_SET" ], + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Snapshot Components" + }, + "BackupSnapshotRetention" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Quantity of time in which MongoDB Cloud measures snapshot retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS", "YEARS" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item.", + "example" : 5 + } + }, + "required" : [ "retentionUnit", "retentionValue" ] + }, + "BackupTenantSnapshot" : { + "type" : "object", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "BaseAtlasDataLakeRegion" : { + "type" : "object", + "description" : "Name of the region to which the data lake routes client connections.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + } ] + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ], + "title" : "AWS Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ], + "title" : "Azure Instance Sizes" + }, { + "type" : "string", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } ] + }, + "BaseNetworkPeeringConnectionSettings" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AwsNetworkPeeringConnectionSettings", + "AZURE" : "#/components/schemas/AzureNetworkPeeringConnectionSettings", + "GCP" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AwsNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/AzureNetworkPeeringConnectionSettings" + }, { + "$ref" : "#/components/schemas/GCPNetworkPeeringConnectionSettings" + } ], + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "containerId" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + } ] + }, + "BasicBSONList" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "BiConnector" : { + "type" : "object", + "description" : "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.", + "externalDocs" : { + "description" : "MongoDB Connector for Business Intelligence", + "url" : "https://docs.mongodb.com/bi-connector/current/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster." + }, + "readPreference" : { + "type" : "string", + "description" : "Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to `ANALYTICS` node, or `SECONDARY` if there are no `ANALYTICS` nodes.", + "enum" : [ "PRIMARY", "SECONDARY", "ANALYTICS" ], + "externalDocs" : { + "description" : "Read preferences for BI Connector", + "url" : "https://docs.atlas.mongodb.com/cluster-config/enable-bic/#std-label-bic-read-preferences" + } + } + }, + "title" : "MongoDB Connector for Business Intelligence Settings" + }, + "BillingEventTypeViewAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "PENDING_INVOICE_OVER_THRESHOLD", + "title" : "Billing Event Type" + }, + "BillingEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "example" : "CREDIT_CARD_CURRENT", + "title" : "Billing Event Types" + }, + "BillingEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "example" : "CHARGE_SUCCEEDED", + "title" : "Billing Event Types" + }, + "BillingEventViewForNdsGroup" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingEventViewForOrg" : { + "type" : "object", + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice payment associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Billing Events" + }, + "BillingInvoice" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lineItems" : { + "type" : "array", + "description" : "List that contains individual services included in this invoice.", + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + }, + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "payments" : { + "type" : "array", + "description" : "List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + }, + "readOnly" : true + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "items" : { + "$ref" : "#/components/schemas/BillingRefund" + }, + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingInvoiceMetadata" : { + "type" : "object", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "creditsCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startingBalanceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "enum" : [ "PENDING", "CLOSED", "FORGIVEN", "FAILED", "PAID", "FREE", "PREPAID", "INVOICED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "BillingPayment" : { + "type" : "object", + "description" : "Funds transferred to MongoDB to cover the specified service in this invoice.", + "properties" : { + "amountBilledCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "amountPaidCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currency" : { + "type" : "string", + "description" : "The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "salesTaxCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "statusName" : { + "type" : "string", + "description" : "Phase of payment processing for the associated invoice when you made this request.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "FAILED_AUTHENTICATION", "PROCESSING", "PENDING_REVERSAL", "REFUNDED" ] + }, + "subtotalCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).", + "readOnly" : true + }, + "unitPrice" : { + "type" : "string", + "description" : "The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "title" : "Payment" + }, + "BillingRefund" : { + "type" : "object", + "description" : "One payment that MongoDB returned to the organization for this invoice.", + "properties" : { + "amountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "paymentId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "reason" : { + "type" : "string", + "description" : "Justification that MongoDB accepted to return funds to the organization.", + "readOnly" : true + } + }, + "title" : "Refund" + }, + "BillingThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Billing Threshold Alert Configuration" + }, + "CloudAccessRoleAssignment" : { + "type" : "object", + "description" : "MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. Each role can apply to one organization or one project but not both.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or **orgId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or **groupId** but not both in the same request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "title" : "Role Assignment" + }, + "CloudAppUser" : { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "pattern" : "^([A-Z]{2})$" + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account is created. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "deprecated" : true, + "description" : "Email address that belongs to the MongoDB Cloud user.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + }, + "password" : { + "type" : "string", + "description" : "Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.", + "minLength" : 8 + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user." + } + }, + "required" : [ "country", "emailAddress", "firstName", "lastName", "mobileNumber", "password", "username" ] + }, + "CloudCluster" : { + "type" : "object", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "properties" : { + "alertCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of alerts open on the cluster.", + "readOnly" : true + }, + "authEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "availability" : { + "type" : "string", + "description" : "Term that expresses how many nodes of the cluster can be accessed when MongoDB Cloud receives this request. This parameter returns `available` when all nodes are accessible, `warning` only when some nodes in the cluster can be accessed, `unavailable` when the cluster can't be accessed, or `dead` when the cluster has been deactivated.", + "enum" : [ "available", "dead", "unavailable", "warning" ], + "readOnly" : true + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.", + "readOnly" : true + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the cluster. Each ``clusterId`` is used only once across all MongoDB Cloud deployments.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "dataSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Total size of the data stored on each node in the cluster. The resource expresses this value in bytes.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Whole number that indicates the quantity of nodes that comprise the cluster.", + "readOnly" : true + }, + "sslEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether TLS authentication is required to access the nodes in this cluster.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that indicates the cluster type.", + "enum" : [ "REPLICA_SET", "SHARDED_CLUSTER" ], + "readOnly" : true + }, + "versions" : { + "type" : "array", + "description" : "List that contains the versions of MongoDB that each node in the cluster runs.", + "items" : { + "type" : "string" + }, + "readOnly" : true, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "CloudDatabaseUser" : { + "type" : "object", + "properties" : { + "awsIAMType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role.", + "enum" : [ "NONE", "USER", "ROLE" ] + }, + "databaseName" : { + "type" : "string", + "default" : "admin", + "description" : "The database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC Workload this value should be `$external`. If the user authenticates with SCRAM-SHA or OIDC Workforce, this value should be `admin`.", + "enum" : [ "admin", "$external" ] + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "labels" : { + "type" : "array", + "description" : "List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "ldapAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host.", + "enum" : [ "NONE", "GROUP", "USER" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oidcAuthType" : { + "type" : "string", + "default" : "NONE", + "description" : "Human-readable label that indicates whether the new database user or group authenticates with OIDC federated authentication. To create a federated authentication user, specify the value of USER in this field. To create a federated authentication group, specify the value of IDP_GROUP in this field.", + "enum" : [ "NONE", "IDP_GROUP", "USER" ] + }, + "password" : { + "type" : "string", + "description" : "Alphanumeric string that authenticates this database user against the database specified in `databaseName`. To authenticate with SCRAM-SHA, you must specify this parameter. This parameter doesn't appear in this response.", + "externalDocs" : { + "description" : "SCRAM-SHA", + "url" : "https://docs.mongodb.com/manual/core/security-scram/" + }, + "minLength" : 8, + "writeOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "List that provides the pairings of one role with one applicable database.", + "items" : { + "$ref" : "#/components/schemas/DatabaseUserRole" + } + }, + "scopes" : { + "type" : "array", + "description" : "List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas Streams Instances in the project.", + "items" : { + "$ref" : "#/components/schemas/UserScope" + } + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "maxLength" : 1024 + }, + "x509Type" : { + "type" : "string", + "default" : "NONE", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + }, + "required" : [ "databaseName", "groupId", "username" ] + }, + "CloudGCPProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/CloudProviderGCPAutoScaling" + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "externalDocs" : { + "description" : "GCP", + "url" : "https://docs.atlas.mongodb.com/reference/google-gcp/" + }, + "title" : "GCP Regions" + } + } + } ] + }, + "CloudProviderAWSAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AWSComputeAutoScaling" + } + } + }, + "CloudProviderAccessAWSIAMRole" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "type" : "string", + "description" : "Amazon Resource Name that identifies the Amazon Web Services (AWS) user account that MongoDB Cloud uses when it assumes the Identity and Access Management (IAM) role.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone authorized this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this role for the specified cloud service provider. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipal" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal in Atlas.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was last updated. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessDataLakeFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageDataLakeFeatureId" + } + } + } ], + "description" : "Details that describe the Atlas Data Lakes linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessEncryptionAtRestFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/ApiAtlasCloudProviderAccessFeatureUsageFeatureIdView" + } + } + } ], + "description" : "Details that describe the Key Management Service (KMS) linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role." + }, + "CloudProviderAccessExportSnapshotFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsageExportSnapshotFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessFeatureUsage" : { + "type" : "object", + "description" : "MongoDB Cloud features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "discriminator" : { + "mapping" : { + "ATLAS_DATA_LAKE" : "#/components/schemas/CloudProviderAccessDataLakeFeatureUsage", + "ENCRYPTION_AT_REST" : "#/components/schemas/CloudProviderAccessEncryptionAtRestFeatureUsage", + "EXPORT_SNAPSHOT" : "#/components/schemas/CloudProviderAccessExportSnapshotFeatureUsage", + "PUSH_BASED_LOG_EXPORT" : "#/components/schemas/CloudProviderAccessPushBasedLogExportFeatureUsage" + }, + "propertyName" : "featureType" + }, + "properties" : { + "featureType" : { + "type" : "string", + "description" : "Human-readable label that describes one MongoDB Cloud feature linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "enum" : [ "ATLAS_DATA_LAKE", "ENCRYPTION_AT_REST", "EXPORT_SNAPSHOT", "PUSH_BASED_LOG_EXPORT" ], + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsageDataLakeFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the data lake linked to this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data lake." + } + } + }, + "CloudProviderAccessFeatureUsageExportSnapshotFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the AWS S3 bucket to which you export your snapshots.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" : { + "type" : "object", + "description" : "Identifying characteristics about the Amazon Web Services (AWS) Simple Storage Service (S3) export bucket linked to this AWS Identity and Access Management (IAM) role.", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "Name of the AWS S3 bucket to which your logs will be exported to.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "CloudProviderAccessPushBasedLogExportFeatureUsage" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, { + "type" : "object", + "properties" : { + "featureId" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsagePushBasedLogExportFeatureId" + } + } + } ], + "description" : "Details that describe the Amazon Web Services (AWS) Simple Storage Service (S3) export buckets linked to this AWS Identity and Access Management (IAM) role." + }, + "CloudProviderAccessRole" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } ], + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoles" : { + "type" : "object", + "properties" : { + "awsIamRoles" : { + "type" : "array", + "description" : "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + } + } + }, + "CloudProviderAzureAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/AzureComputeAutoScalingRules" + } + } + }, + "CloudProviderContainer" : { + "type" : "object", + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderContainer", + "AZURE" : "#/components/schemas/AzureCloudProviderContainer", + "GCP" : "#/components/schemas/GCPCloudProviderContainer" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/GCPCloudProviderContainer" + }, { + "$ref" : "#/components/schemas/AWSCloudProviderContainer" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering containers.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "provisioned" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud clusters exist in the specified network peering container.", + "readOnly" : true + } + } + }, + "CloudProviderEndpointServiceRequest" : { + "type" : "object", + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for [Amazon Web Services](https://docs.atlas.mongodb.com/reference/amazon-aws/), [Google Cloud Platform](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Microsoft Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "providerName", "region" ] + }, + "CloudProviderGCPAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/GCPComputeAutoScaling" + } + } + }, + "CloudProviderRegions" : { + "type" : "object", + "properties" : { + "instanceSizes" : { + "type" : "array", + "description" : "List of instances sizes that this cloud provider supports.", + "items" : { + "$ref" : "#/components/schemas/ClusterCloudProviderInstanceSize" + }, + "readOnly" : true + }, + "provider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud provider.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + }, + "CloudRegionConfig" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig", + "AZURE" : "#/components/schemas/AzureRegionConfig", + "GCP" : "#/components/schemas/GCPRegionConfig", + "TENANT" : "#/components/schemas/TenantRegionConfig" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings for Multi-Cloud Clusters" + }, + "CloudRegionConfig20240805" : { + "type" : "object", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSRegionConfig20240805", + "AZURE" : "#/components/schemas/AzureRegionConfig20240805", + "GCP" : "#/components/schemas/GCPRegionConfig20240805", + "TENANT" : "#/components/schemas/TenantRegionConfig20240805" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20240805" + } ], + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20240805" + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.\n\n**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.", + "maximum" : 7, + "minimum" : 0 + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "regionName" : { + "type" : "object", + "description" : "Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. The region name is only returned in the response for single-region clusters. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR) block. To limit a new VPC peering connection to one Classless Inter-Domain Routing (CIDR) block and region, create the connection first. Deploy the cluster after the connection starts. GCP Clusters and Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.", + "oneOf" : [ { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + }, { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, { + "type" : "string", + "description" : "Google Compute Regions.", + "enum" : [ "EASTERN_US", "GOV_EASTERN_US", "US_EAST_4", "GOV_US_EAST_4", "US_EAST_5", "GOV_US_EAST_5", "US_WEST_2", "GOV_US_WEST_2", "US_WEST_3", "GOV_US_WEST_3", "US_WEST_4", "GOV_US_WEST_4", "US_SOUTH_1", "GOV_US_SOUTH_1", "CENTRAL_US", "GOV_CENTRAL_US", "WESTERN_US", "GOV_WESTERN_US", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "WESTERN_EUROPE", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_8", "EUROPE_WEST_9", "EUROPE_WEST_10", "EUROPE_WEST_12", "EUROPE_SOUTHWEST_1", "EUROPE_CENTRAL_2", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "EASTERN_ASIA_PACIFIC", "NORTHEASTERN_ASIA_PACIFIC", "SOUTHEASTERN_ASIA_PACIFIC", "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2" ], + "title" : "GCP Regions" + } ] + } + }, + "title" : "Cloud Service Provider Settings" + }, + "CloudSearchMetrics" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMetrics" : { + "type" : "array", + "description" : "List that contains all host compute, memory, and storage utilization dedicated to Atlas Search when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "indexMetrics" : { + "type" : "array", + "description" : "List that contains all performance and utilization measurements that Atlas Search index performed by the time MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Hostname and port that identifies the process.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "statusMetrics" : { + "type" : "array", + "description" : "List that contains all available Atlas Search status metrics when MongoDB Atlas received this request.", + "items" : { + "$ref" : "#/components/schemas/FTSMetric" + }, + "readOnly" : true + } + }, + "required" : [ "groupId", "processId" ] + }, + "ClusterAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cluster Alert Configuration" + }, + "ClusterAlertView" : { + "type" : "object", + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Cluster Alerts" + }, + "ClusterAutoScalingSettings" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "externalDocs" : { + "description" : "Cluster Auto-Scaling", + "url" : "https://docs.atlas.mongodb.com/cluster-autoscaling/" + }, + "properties" : { + "compute" : { + "$ref" : "#/components/schemas/ClusterComputeAutoScaling" + }, + "diskGBEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." + } + }, + "title" : "Automatic Cluster Scaling Settings" + }, + "ClusterCloudProviderInstanceSize" : { + "type" : "object", + "properties" : { + "availableRegions" : { + "type" : "array", + "description" : "List of regions that this cloud provider supports for this instance size.", + "items" : { + "$ref" : "#/components/schemas/AvailableCloudProviderRegion" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance size or cluster tier.", + "readOnly" : true + } + } + }, + "ClusterComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." + } + } + }, + "ClusterConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "awsPrivateLink" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "awsPrivateLinkSrv" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "private" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpoint" + }, + "readOnly" : true + }, + "privateSrv" : { + "type" : "string", + "description" : "Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the `mongodb+srv://` protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon Web Services (AWS) clusters, this parameter returns only if you [enable custom DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).", + "externalDocs" : { + "description" : "Network Peering Connection", + "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" + }, + "readOnly" : true + }, + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cluster Connection Strings" + }, + "ClusterDescription20240805" : { + "type" : "object", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "backupEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/) for dedicated clusters and [Shared Cluster Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant clusters. If set to `false`, the cluster doesn't use backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this cluster. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must be `M10` or higher and `\"backupEnabled\" : false` or omitted entirely.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20240805" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + } + }, + "ClusterDescriptionConnectionStringsPrivateEndpoint" : { + "type" : "object", + "description" : "Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Dedicated Cluster", + "url" : "https://docs.atlas.mongodb.com/security-private-endpoint/" + }, + "properties" : { + "connectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.", + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].connectionString** or **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.", + "readOnly" : true + }, + "srvShardOptimizedConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string optimized for sharded clusters that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects. Use `MONGOD` for replica sets and `MONGOS` for sharded clusters.", + "enum" : [ "MONGOD", "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection String" + }, + "ClusterDescriptionConnectionStringsPrivateEndpointEndpoint" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this cluster.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider in which MongoDB Cloud deploys the private endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Cluster Private Endpoint Connection Strings Endpoint" + }, + "ClusterDescriptionProcessArgs" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultReadConcern" : { + "type" : "string", + "default" : "available", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 4.4 clusters default to `available`. MongoDB 5.0 and later clusters default to `local`.", + "enum" : [ "local", "available" ], + "externalDocs" : { + "description" : "This option corresponds to the global default read concern.", + "url" : "https://docs.mongodb.com/manual/reference/read-concern/" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "failIndexKeyTooLong" : { + "type" : "boolean", + "default" : true, + "deprecated" : true, + "description" : "Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, [mongod](https://docs.mongodb.com/upcoming/reference/program/mongod/#mongodb-binary-bin.mongod) writes documents that exceed this limit but doesn't index them. This parameter has been removed as of [MongoDB 4.4](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong).", + "externalDocs" : { + "description" : "This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterDescriptionProcessArgs20240805" : { + "type" : "object", + "properties" : { + "chunkMigrationConcurrency" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of threads on the source shard and the receiving shard for chunk migration. The number of threads should not exceed the half the total number of CPU cores in the sharded cluster.", + "externalDocs" : { + "description" : "This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" + } + }, + "defaultWriteConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", + "externalDocs" : { + "description" : "This option corresponds to the the implicit default write concern.", + "url" : "https://docs.mongodb.com/manual/reference/write-concern/" + } + }, + "javascriptEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "externalDocs" : { + "description" : "This option corresponds to modifying the `security.javascriptEnabled` configuration file option for each `mongod` and `mongos` in the cluster.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-security.javascriptEnabled" + } + }, + "minimumEnabledTlsProtocol" : { + "type" : "string", + "description" : "Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.", + "enum" : [ "TLS1_0", "TLS1_1", "TLS1_2" ], + "externalDocs" : { + "description" : "This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-net.ssl.disabledProtocols" + } + }, + "noTableScan" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.", + "externalDocs" : { + "description" : "This option corresponds to the `notablescan` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.notablescan" + } + }, + "oplogMinRetentionHours" : { + "type" : "number", + "format" : "double", + "description" : "Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-storage.oplogMinRetentionHours" + }, + "nullable" : true + }, + "oplogSizeMB" : { + "type" : "integer", + "format" : "int32", + "description" : "Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.", + "externalDocs" : { + "description" : "This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.", + "url" : "https://docs.mongodb.com/upcoming/reference/configuration-options/#mongodb-setting-replication.oplogSizeMB" + }, + "nullable" : true + }, + "queryStatsLogVerbosity" : { + "type" : "integer", + "format" : "int32", + "description" : "May be set to 1 (disabled) or 3 (enabled). When set to 3, Atlas will include redacted and anonymized $queryStats output in MongoDB logs. $queryStats output does not contain literals or field values. Enabling this setting might impact the performance of your cluster.", + "externalDocs" : { + "description" : "This option corresponds to the queryStats component for the logComponentVerbosity server parameter.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.logComponentVerbosity" + } + }, + "sampleRefreshIntervalBIConnector" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Interval in seconds at which the mongosqld process re-samples data to create its relational schema.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--schemaRefreshIntervalSecs" + }, + "minimum" : 0 + }, + "sampleSizeBIConnector" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of documents per database to sample when gathering schema information.", + "externalDocs" : { + "description" : "This option corresponds to the `sampleSize` `mongosqld` option.", + "url" : "https://docs.mongodb.com/bi-connector/current/reference/mongosqld/#std-option-mongosqld.--sampleSize" + }, + "minimum" : 0 + }, + "transactionLifetimeLimitSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.", + "externalDocs" : { + "description" : "This option corresponds to the `transactionLifetimeLimitSeconds` `mongod` configuration file option.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds" + }, + "minimum" : 1 + } + } + }, + "ClusterEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_MISSING", + "title" : "Cluster Event Types" + }, + "ClusterEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "example" : "CLUSTER_MONGOS_IS_PRESENT", + "title" : "Cluster Event Types" + }, + "ClusterEventViewForNdsGroup" : { + "type" : "object", + "description" : "Cluster event identifies different activities about cluster of mongod hosts.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Cluster Events" + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "description" : "Range of instance sizes to which your cluster can scale.", + "properties" : { + "compute" : { + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.", + "title" : "Tenant" + } + } + }, + "ClusterFreeProviderSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, { + "type" : "object", + "properties" : { + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterFreeAutoScaling" + }, + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when **providerSettings.providerName** is `TENANT` and **providerSetting.instanceSizeName** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "instanceSizeName" : { + "type" : "string", + "description" : "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set **providerSettings.providerName** to `TENANT` and specify the cloud service provider in **providerSettings.backingProviderName**.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/). For multi-region clusters, see **replicationSpec.{region}**." + } + } + } ] + }, + "ClusterIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a cluster.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "items" : { + "type" : "string" + }, + "readOnly" : true + } + }, + "title" : "Cluster IP Addresses" + }, + "ClusterMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an cluster against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ClusterMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ClusterMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "CLUSTER_NAME" ], + "example" : "CLUSTER_NAME", + "title" : "Cluster Matcher Fields" + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project that contains the cluster to undergo outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the outage simulation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "outageFilters" : { + "type" : "array", + "description" : "List of settings that specify the type of cluster outage simulation.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + }, + "minItems" : 1 + }, + "startRequestDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ], + "readOnly" : true + } + } + }, + "ClusterProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB hosts.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCloudProviderSettings", + "AZURE" : "#/components/schemas/AzureCloudProviderSettings", + "GCP" : "#/components/schemas/CloudGCPProviderSettings", + "TENANT" : "#/components/schemas/ClusterFreeProviderSettings" + }, + "propertyName" : "providerName" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ], + "properties" : { + "providerName" : { + "type" : "string" + } + }, + "required" : [ "providerName" ], + "title" : "Cloud Service Provider Settings for a Cluster" + }, + "ClusterSearchIndex" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/SearchIndex", + "vectorSearch" : "#/components/schemas/VectorSearchIndex" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ], + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "ClusterServerlessBackupOptions" : { + "type" : "object", + "description" : "Group of settings that configure serverless backup.", + "properties" : { + "serverlessContinuousBackupEnabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether the serverless instance uses **Serverless Continuous Backup**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |" + } + }, + "title" : "Serverless Backup Options" + }, + "ClusterStatus" : { + "type" : "object", + "properties" : { + "changeStatus" : { + "type" : "string", + "description" : "State of cluster at the time of this request. Atlas returns **Applied** if it completed adding a user to, or removing a user from, your cluster. Atlas returns **Pending** if it's still making the requested user changes. When status is **Pending**, new users can't log in.", + "enum" : [ "PENDING", "APPLIED" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "Collation" : { + "type" : "object", + "description" : "One or more settings that specify language-specific rules to compare strings within this index.", + "externalDocs" : { + "description" : "Collation Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "alternate" : { + "type" : "string", + "default" : "non-ignorable", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "enum" : [ "non-ignorable", "shifted" ] + }, + "backwards" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether strings with diacritics sort from back of the string. Some French dictionary orders strings in this way.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n" + }, + "caseFirst" : { + "type" : "string", + "default" : "off", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n" + }, + "locale" : { + "type" : "string", + "description" : "International Components for Unicode (ICU) code that represents a localized language. To specify simple binary comparison, set `\"locale\" : \"simple\"`.", + "enum" : [ "af", "sq", "am", "ar", "hy", "as", "az", "bn", "be", "bs", "bs_Cyrl", "bg", "my", "ca", "chr", "zh", "zh_Hant", "hr", "cs", "da", "nl", "dz", "en", "en_US", "en_US_POSIX", "eo", "et", "ee", "fo", "fil", "fi_FI", "fr", "fr_CA", "gl", "ka", "de", "de_AT", "el", "gu", "ha", "haw", "he", "hi", "hu", "is", "ig", "smn", "id", "ga", "it", "ja", "kl", "kn", "kk", "km", "kok", "ko", "ky", "lk", "lo", "lv", "li", "lt", "dsb", "lb", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "se", "nb", "nn", "or", "om", "ps", "fa", "fa_AF", "pl", "pt", "pa", "ro", "ru", "sr", "sr_Latn", "si", "sk", "sl", "es", "sw", "sv", "ta", "te", "th", "bo", "to", "tr", "uk", "hsb", "ur", "ug", "vi", "wae", "cy", "yi", "yo", "zu", "simple" ] + }, + "maxVariable" : { + "type" : "string", + "description" : "Field that indicates which characters can be ignored when `\"alternate\" : \"shifted\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "enum" : [ "punct", "space" ] + }, + "normalization" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to check if the text requires normalization and then perform it. Most text doesn't require this normalization processing.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n" + }, + "numericOrdering" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n" + }, + "strength" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 3 | Tertiary | Compares base characters (primary), diacritics (secondary), and case and variants (tertiary). Differences between base characters takes precedence over secondary differences which take precedence over tertiary differences. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "maximum" : 5, + "minimum" : 1 + } + }, + "required" : [ "locale" ], + "writeOnly" : true + }, + "ComponentLabel" : { + "type" : "object", + "description" : "Human-readable labels applied to this MongoDB Cloud component.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Value set to the Key applied to tag and categorize this component.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "title" : "Component Label" + }, + "ConnectedOrgConfig" : { + "type" : "object", + "properties" : { + "dataAccessIdentityProviderIds" : { + "type" : "array", + "description" : "The collection of unique ids representing the identity providers that can be used for data access in this organization.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that represents the id of the identity providers that can be used for data access in this organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "domainAllowList" : { + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the UI access identity provider that this connected org config is associated with. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "postAuthRoleGrants" : { + "type" : "array", + "description" : "Atlas roles that are granted to a user in this organization after authenticating. Roles are a human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific MongoDB Cloud user. These roles can only be organization specific roles.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "roleMappings" : { + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "uniqueItems" : true + }, + "userConflicts" : { + "type" : "array", + "description" : "List that contains the users who have an email address that doesn't match any domain on the allowed list.", + "items" : { + "$ref" : "#/components/schemas/FederatedUser" + } + } + }, + "required" : [ "domainRestrictionEnabled", "orgId" ] + }, + "ControlPlaneIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in the Atlas control plane.", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "title" : "Control Plane IP Addresses" + }, + "CostExplorerFilterRequestBody" : { + "type" : "object", + "description" : "Request body for a cost explorer query.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "format" : "date", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "format" : "date", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "example" : "2022-02-01" + } + }, + "required" : [ "endDate", "startDate" ] + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "description" : "Response object to give information about created query.", + "properties" : { + "token" : { + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71", + "maxLength" : 64, + "minLength" : 64 + } + } + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], + "example" : "CPS_SNAPSHOT_BEHIND", + "title" : "Cps Backup Event Type" + }, + "CpsBackupThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Cps Backup Threshold Alert Configuration" + }, + "CreateAWSEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "vpce-3bf78b0ddee411ba1", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id" ], + "title" : "AWS" + }, + "CreateAtlasOrganizationApiKey" : { + "type" : "object", + "description" : "Details of the programmatic API key to be created.", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone created this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "minItems" : 1 + } + }, + "required" : [ "desc", "roles" ] + }, + "CreateAzureEndpointRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.", + "example" : "/subscriptions/cba6d9c6-1d3f-3c11-03cb-c705d895e636/resourcegroups/qrRTqi4TSN)7yB5YLRjVDveH3.yLzpNR7Br0D3-SGrU3j0.0/providers/Microsoft.Network/privateEndpoints/pVP(vb(XeckpxtXzP0NaOsDjeWDbOK)DX8A2j2E_vBYL2.GEYIdln", + "writeOnly" : true + }, + "privateEndpointIPAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "id", "privateEndpointIPAddress" ], + "title" : "AZURE" + }, + "CreateDataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you wish to store your archived data. **AZURE** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "writeOnly" : true + }, + "CreateEndpointRequest" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/CreateAWSEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateAzureEndpointRequest" + }, { + "$ref" : "#/components/schemas/CreateGCPEndpointGroupRequest" + } ] + }, + "CreateGCPEndpointGroupRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CreateEndpointRequest" + }, { + "type" : "object", + "properties" : { + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "writeOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/CreateGCPForwardingRuleRequest" + } + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the Google Cloud project in which you created the endpoints.", + "example" : "p-fdeeb3e43b8e733e5ab627b1", + "externalDocs" : { + "description" : "Google Cloud Creating and Managing Projects", + "url" : "https://cloud.google.com/resource-manager/docs/creating-managing-projects" + }, + "pattern" : "^p-[0-9a-z]{24}$", + "writeOnly" : true + } + } + } ], + "description" : "Group of Private Endpoint settings.", + "required" : [ "endpointGroupName", "gcpProjectId" ], + "title" : "GCP" + }, + "CreateGCPForwardingRuleRequest" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "writeOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + }, + "title" : "GCP Forwarding Rules" + }, + "CreateOrganizationRequest" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to link the newly created organization to. If specified, the proposed Organization Owner of the new organization must have the Organization Owner role in an organization associated with the federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you want to assign the Organization Owner role. This user must be a member of the same organization as the calling API key. If you provide `federationSettingsId`, this user must instead have the Organization Owner role on an organization in the specified federation. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "name" ] + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation that you linked the newly created organization to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgOwnerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user that you assigned the Organization Owner role in the new organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "organization" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + }, + "required" : [ "bucketName", "iamRoleId", "prefixPath" ] + }, + "CriteriaView" : { + "type" : "object", + "description" : "Rules by which MongoDB Cloud archives data.\n\nUse the **criteria.type** field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"criteria.type\": \"CUSTOM\"** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **\"criteria.type\": \"CUSTOM\"** when **\"collectionType\": \"TIMESERIES\"**.", + "discriminator" : { + "mapping" : { + "CUSTOM" : "#/components/schemas/CustomCriteriaView", + "DATE" : "#/components/schemas/DateCriteriaView" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.\n**DATE** selects documents to archive based on a date.\n**CUSTOM** selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support **CUSTOM** when `\"collectionType\": \"TIMESERIES\"`.", + "enum" : [ "DATE", "CUSTOM" ] + } + } + }, + "CustomCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "query" : { + "type" : "string", + "description" : "MongoDB find query that selects documents to archive. The specified query follows the syntax of the `db.collection.find(query)` command. This query can't use the empty document (`{}`) to return all documents. Set this parameter when **\"criteria.type\" : \"CUSTOM\"**." + } + } + } ], + "description" : "**CUSTOM criteria.type**.", + "required" : [ "query" ], + "title" : "Archival Criteria" + }, + "CustomZoneMappings" : { + "type" : "object", + "properties" : { + "customZoneMappings" : { + "type" : "array", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.\n\nThis parameter returns an empty object if no custom zones exist.", + "items" : { + "$ref" : "#/components/schemas/ZoneMapping" + } + } + } + }, + "DBRoleToExecute" : { + "type" : "object", + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ], + "title" : "DB Role Type" + } + } + }, + "DBUserTLSX509Settings" : { + "type" : "object", + "description" : "Settings to configure TLS Certificates for database users.", + "properties" : { + "cas" : { + "type" : "string", + "description" : "Concatenated list of customer certificate authority (CA) certificates needed to authenticate database users. MongoDB Cloud expects this as a PEM-formatted certificate." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "title" : "Database User TLS Certificate Settings" + }, + "DLSIngestionSink" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSink" + }, { + "type" : "object", + "properties" : { + "metadataProvider" : { + "type" : "string", + "description" : "Target cloud provider for this Data Lake Pipeline.", + "enum" : [ "AWS" ] + }, + "metadataRegion" : { + "type" : "string", + "description" : "Target cloud provider region for this Data Lake Pipeline.", + "externalDocs" : { + "description" : "Supported cloud provider regions", + "url" : "https://www.mongodb.com/docs/datalake/limitations" + } + }, + "partitionFields" : { + "type" : "array", + "description" : "Ordered fields used to physically organize data in the destination.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ], + "description" : "Atlas Data Lake Storage as the destination for a Data Lake Pipeline.", + "title" : "DLS Ingestion Destination" + }, + "DailyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "DataExpirationRuleView" : { + "type" : "object", + "description" : "Rule for specifying when data should be deleted from the archive.", + "properties" : { + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days used in the date criteria for nominating documents for deletion.", + "maximum" : 9215, + "minimum" : 7 + } + } + }, + "DataExplorerAccessedEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "example" : "DATA_EXPLORER", + "title" : "Data Explorer Accessed Event Types" + }, + "DataExplorerAccessedEventView" : { + "type" : "object", + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection on which the event occurred. The resource returns this parameter when the **eventTypeName** includes `DATA_EXPLORER`.", + "example" : "test_collection", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label of the database on which this incident occurred. The resource returns this parameter when `\"eventTypeName\" : \"DATA_EXPLORER\"` or `\"eventTypeName\" : \"DATA_EXPLORER_CRUD\"`.", + "example" : "test_db", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/DataExplorerAccessedEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "opType" : { + "type" : "string", + "description" : "Action that the database attempted to execute when the event triggered. The response returns this parameter when `eventTypeName\" : \"DATA_EXPLORER\"`.", + "example" : "insertDocument", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Data Explorer Accessed Events" + }, + "DataFederationAzureCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in Azure.", + "properties" : { + "atlasAppId" : { + "type" : "string", + "description" : "The App ID generated by Atlas for the Service Principal's access policy.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "readOnly" : true + }, + "tenantId" : { + "type" : "string", + "description" : "The Azure Active Directory / Entra ID tenant ID associated with the Service Principal.", + "readOnly" : true + } + }, + "required" : [ "roleId" ] + }, + "DataFederationLimit" : { + "type" : "object", + "description" : "Details of user managed limits.", + "discriminator" : { + "mapping" : { + "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", + "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.crossRegionEntries" : "#/components/schemas/DefaultLimit", + "atlas.project.security.networkAccess.entries" : "#/components/schemas/DefaultLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit" + }, + "propertyName" : "name" + }, + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Limits" + }, + "DataFederationQueryLimit" : { + "type" : "object", + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Query Limit" + }, + "DataFederationTenantQueryLimit" : { + "type" : "object", + "description" : "Details of a tenant-level query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost.", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Only used for Data Federation limits. Timestamp that indicates when this usage limit was last modified. This field uses the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "overrunPolicy" : { + "type" : "string", + "description" : "Only used for Data Federation limits. Action to take when the usage limit is exceeded. If limit span is set to QUERY, this is ignored because MongoDB Cloud stops the query when it exceeds the usage limit.", + "enum" : [ "BLOCK", "BLOCK_AND_KILL" ] + }, + "tenantName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance. If specified, the usage limit is for the specified federated database instance only. If omitted, the usage limit is for all federated database instances in the project.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Data Federation Tenant-Level Query Limit" + }, + "DataLakeAWSCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in AWS.", + "properties" : { + "externalId" : { + "type" : "string", + "description" : "Unique identifier associated with the Identity and Access Management (IAM) role that the data lake assumes when accessing the data stores.", + "readOnly" : true + }, + "iamAssumedRoleARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the data lake assumes when accessing data stores.", + "example" : "arn:aws:iam::123456789012:root", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + }, + "testS3Bucket" : { + "type" : "string", + "description" : "Name of the S3 data bucket that the provided role ID is authorized to access.Required if specifying cloudProviderConfig.", + "writeOnly" : true + } + }, + "required" : [ "roleId", "testS3Bucket" ] + }, + "DataLakeApiBase" : { + "type" : "object", + "description" : "An aggregation pipeline that applies to the collection.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection." + }, + "pipeline" : { + "type" : "string", + "description" : "Aggregation pipeline stages to apply to the source collection.", + "externalDocs" : { + "description" : "Aggregation Pipelines", + "url" : "https://docs.mongodb.com/manual/core/aggregation-pipeline/" + } + }, + "source" : { + "type" : "string", + "description" : "Human-readable label that identifies the source collection for the view." + } + } + }, + "DataLakeAtlasStoreInstance" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label of the MongoDB Cloud cluster on which the store is based." + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readConcern" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadConcern" + }, + "readPreference" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreference" + } + } + } ] + }, + "DataLakeAtlasStoreReadConcern" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read concern, which determines the consistency and isolation properties of the data read from an Atlas cluster.", + "properties" : { + "level" : { + "type" : "string", + "description" : "Read Concern level that specifies the consistency and availability of the data read.", + "enum" : [ "LOCAL", "MAJORITY", "LINEARIZABLE", "SNAPSHOT", "AVAILABLE" ], + "externalDocs" : { + "description" : "Read Concern Level", + "url" : "https://www.mongodb.com/docs/manual/reference/read-concern/#read-concern-levels" + } + } + } + }, + "DataLakeAtlasStoreReadPreference" : { + "type" : "object", + "description" : "MongoDB Cloud cluster read preference, which describes how to route read requests to the cluster.", + "properties" : { + "maxStalenessSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Maximum replication lag, or **staleness**, for reads from secondaries." + }, + "mode" : { + "type" : "string", + "description" : "Read preference mode that specifies to which replica set member to route the read requests.", + "enum" : [ "primary", "primaryPreferred", "secondary", "secondaryPreferred", "nearest" ], + "externalDocs" : { + "description" : "Read Preference Modes", + "url" : "https://docs.mongodb.com/manual/core/read-preference/#read-preference-modes" + } + }, + "tagSets" : { + "type" : "array", + "description" : "List that contains tag sets or tag specification documents. If specified, Atlas Data Lake routes read requests to replica set member or members that are associated with the specified tags.", + "externalDocs" : { + "description" : "Read Preference Tag Set Lists", + "url" : "https://docs.mongodb.com/manual/core/read-preference-tags/" + }, + "items" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeAtlasStoreReadPreferenceTag" + } + } + } + } + }, + "DataLakeAtlasStoreReadPreferenceTag" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label of the tag." + }, + "value" : { + "type" : "string", + "description" : "Value of the tag." + } + } + }, + "DataLakeAzureBlobStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "containerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the name of the container." + }, + "delimiter" : { + "type" : "string", + "description" : "Delimiter." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the blob store is public. If set to `true`, MongoDB Cloud doesn't use the configured Azure service principal to access the blob store. If set to `false`, the configured Azure service principal must include permissions to access the blob store." + }, + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + }, + "replacementDelimiter" : { + "type" : "string", + "description" : "Replacement Delimiter." + }, + "serviceURL" : { + "type" : "string", + "description" : "Service URL." + } + } + } ] + }, + "DataLakeCloudProviderConfig" : { + "type" : "object", + "description" : "Cloud provider where this Federated Database Instance is hosted.", + "properties" : { + "aws" : { + "$ref" : "#/components/schemas/DataLakeAWSCloudProviderConfig" + }, + "azure" : { + "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + } + }, + "title" : "Data Lake Cloud Provider" + }, + "DataLakeDLSAWSStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeDLSAzureStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "region" : { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } + } + } ] + }, + "DataLakeDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region to which the Federated Database Instance routes client connections.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", + "enum" : [ "AWS", "AZURE" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "DataLakeDatabaseCollection" : { + "type" : "object", + "description" : "A collection and data sources that map to a ``stores`` data store.", + "properties" : { + "dataSources" : { + "type" : "array", + "description" : "Array that contains the data stores that map to a collection for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseDataSourceSettings" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." + } + } + }, + "DataLakeDatabaseDataSourceSettings" : { + "type" : "object", + "description" : "Data store that maps to a collection for this data lake.", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." + }, + "collectionRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) collection. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (`*`) collections for dynamically generated databases." + }, + "databaseRegex" : { + "type" : "string", + "description" : "Regex pattern to use for creating the wildcard (*) database. To learn more about the regex syntax, see [Go programming language](https://pkg.go.dev/regexp)." + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates for an ingestion pipeline run or Online Archive.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z" + }, + "datasetPrefix" : { + "type" : "string", + "description" : "Human-readable label that matches against the dataset names for ingestion pipeline runs or Online Archives." + }, + "defaultFormat" : { + "type" : "string", + "description" : "File format that MongoDB Cloud uses if it encounters a file without a file extension while searching **storeName**.", + "enum" : [ ".avro", ".avro.bz2", ".avro.gz", ".bson", ".bson.bz2", ".bson.gz", ".bsonx", ".csv", ".csv.bz2", ".csv.gz", ".json", ".json.bz2", ".json.gz", ".orc", ".parquet", ".tsv", ".tsv.bz2", ".tsv.gz" ] + }, + "path" : { + "type" : "string", + "description" : "File path that controls how MongoDB Cloud searches for and parses files in the **storeName** before mapping them to a collection.Specify ``/`` to capture all files and folders from the ``prefix`` path." + }, + "provenanceFieldName" : { + "type" : "string", + "description" : "Name for the field that includes the provenance of the documents in the results. MongoDB Cloud returns different fields in the results for each supported provider." + }, + "storeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store that MongoDB Cloud maps to the collection." + }, + "trimLevel" : { + "type" : "integer", + "format" : "int32", + "description" : "Unsigned integer that specifies how many fields of the dataset name to trim from the left of the dataset name before mapping the remaining fields to a wildcard collection name." + }, + "urls" : { + "type" : "array", + "description" : "URLs of the publicly accessible data files. You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the **dataSources.storeName** parameter.", + "items" : { + "type" : "string" + } + } + } + }, + "DataLakeDatabaseInstance" : { + "type" : "object", + "description" : "Database associated with this data lake. Databases contain collections and views.", + "properties" : { + "collections" : { + "type" : "array", + "description" : "Array of collections and data sources that map to a ``stores`` data store.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseCollection" + } + }, + "maxWildcardCollections" : { + "type" : "integer", + "format" : "int32", + "default" : 100, + "description" : "Maximum number of wildcard collections in the database. This only applies to S3 data sources.", + "maximum" : 1000, + "minimum" : 1 + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." + }, + "views" : { + "type" : "array", + "description" : "Array of aggregation pipelines that apply to the collection. This only applies to S3 data sources.", + "items" : { + "$ref" : "#/components/schemas/DataLakeApiBase" + } + } + } + }, + "DataLakeHTTPStore" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "allowInsecure" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that validates the scheme in the specified URLs. If `true`, allows insecure `HTTP` scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If `false`, allows secure `HTTPS` scheme only." + }, + "defaultFormat" : { + "type" : "string", + "description" : "Default format that Data Lake assumes if it encounters a file without an extension while searching the `storeName`. If omitted, Data Lake attempts to detect the file type by processing a few bytes of the file. The specified format only applies to the URLs specified in the **databases.[n].collections.[n].dataSources** object." + }, + "urls" : { + "type" : "array", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication.", + "items" : { + "type" : "string", + "description" : "Comma-separated list of publicly accessible HTTP URLs where data is stored. You can't specify URLs that require authentication." + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "type" : "object", + "description" : "Details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the group.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the Data Lake Pipeline was updated.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Name of this Data Lake Pipeline." + }, + "sink" : { + "$ref" : "#/components/schemas/IngestionSink" + }, + "source" : { + "$ref" : "#/components/schemas/IngestionSource" + }, + "state" : { + "type" : "string", + "description" : "State of this Data Lake Pipeline.", + "enum" : [ "ACTIVE", "PAUSED" ], + "readOnly" : true + }, + "transformations" : { + "type" : "array", + "description" : "Fields to be excluded for this Data Lake Pipeline.", + "items" : { + "$ref" : "#/components/schemas/FieldTransformation" + } + } + }, + "title" : "Data Lake Pipeline" + }, + "DataLakePipelinesPartitionField" : { + "type" : "object", + "description" : "Partition Field in the Data Lake Storage provider for a Data Lake Pipeline.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the field name used to partition data.", + "maxLength" : 700 + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Partition Field" + }, + "DataLakeS3StoreSettings" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + }, { + "type" : "object", + "properties" : { + "additionalStorageClasses" : { + "type" : "array", + "description" : "Collection of AWS S3 [storage classes](https://aws.amazon.com/s3/storage-classes/). Atlas Data Lake includes the files in these storage classes in the query results.", + "items" : { + "type" : "string", + "description" : "AWS S3 [storage class](https://aws.amazon.com/s3/storage-classes/) where the files to include in the results are stored.", + "enum" : [ "STANDARD", "INTELLIGENT_TIERING", "STANDARD_IA" ] + } + }, + "bucket" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 bucket. This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials." + }, + "delimiter" : { + "type" : "string", + "description" : "The delimiter that separates **databases.[n].collections.[n].dataSources.[n].path** segments in the data store. MongoDB Cloud uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter. For example, you can specify an underscore (_) or a plus sign (+) or multiple characters, such as double underscores (__) as the delimiter. If omitted, defaults to `/`." + }, + "includeTags" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes. If set to `true`, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document." + }, + "prefix" : { + "type" : "string", + "description" : "Prefix that MongoDB Cloud applies when searching for files in the S3 bucket. The data store prepends the value of prefix to the **databases.[n].collections.[n].dataSources.[n].path** to create the full path for files to ingest. If omitted, MongoDB Cloud searches all files from the root of the S3 bucket." + }, + "public" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the bucket is public. If set to `true`, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket. If set to `false`, the configured AWS IAM role must include permissions to access the S3 bucket." + }, + "region" : { + "type" : "string", + "description" : "Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.", + "enum" : [ "US_GOV_WEST_1", "US_GOV_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "CA_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "EU_WEST_2", "EU_WEST_3", "EU_CENTRAL_1", "EU_CENTRAL_2", "AP_EAST_1", "AP_NORTHEAST_1", "AP_NORTHEAST_2", "AP_NORTHEAST_3", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "AP_SOUTHEAST_4", "AP_SOUTH_1", "AP_SOUTH_2", "SA_EAST_1", "CN_NORTH_1", "CN_NORTHWEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "AF_SOUTH_1", "EU_SOUTH_1", "EU_SOUTH_2", "IL_CENTRAL_1", "CA_WEST_1", "GLOBAL" ], + "title" : "AWS Regions" + } + } + } ] + }, + "DataLakeStorage" : { + "type" : "object", + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases.", + "properties" : { + "databases" : { + "type" : "array", + "description" : "Array that contains the queryable databases and collections for this data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeDatabaseInstance" + } + }, + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" + } + } + } + }, + "DataLakeStoreSettings" : { + "type" : "object", + "description" : "Group of settings that define where the data is stored.", + "discriminator" : { + "mapping" : { + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "azure" : "#/components/schemas/DataLakeAzureBlobStore", + "dls:aws" : "#/components/schemas/DataLakeDLSAWSStore", + "dls:azure" : "#/components/schemas/DataLakeDLSAzureStore", + "http" : "#/components/schemas/DataLakeHTTPStore", + "s3" : "#/components/schemas/DataLakeS3StoreSettings" + }, + "propertyName" : "provider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ], + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the data store. The **databases.[n].collections.[n].dataSources.[n].storeName** field references this values as part of the mapping configuration. To use MongoDB Cloud as a data store, the data lake requires a serverless instance or an `M10` or higher cluster." + }, + "provider" : { + "type" : "string" + } + }, + "required" : [ "provider" ] + }, + "DataLakeTenant" : { + "type" : "object", + "properties" : { + "cloudProviderConfig" : { + "$ref" : "#/components/schemas/DataLakeCloudProviderConfig" + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/DataLakeDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the Federated Database Instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the Federated Database Instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the Federated Database Instance." + }, + "privateEndpointHostnames" : { + "type" : "array", + "description" : "List that contains the sets of private endpoints and hostnames.", + "items" : { + "$ref" : "#/components/schemas/PrivateEndpointHostname" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the status of the Federated Database Instance.", + "enum" : [ "UNVERIFIED", "ACTIVE", "DELETED" ], + "readOnly" : true + }, + "storage" : { + "$ref" : "#/components/schemas/DataLakeStorage" + } + } + }, + "DataMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "DataMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "DataMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "DataMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], + "example" : "BYTES", + "title" : "Data Metric Units" + }, + "DataMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/DataMetricUnits" + } + }, + "readOnly" : true, + "title" : "Data Metric Value" + }, + "DataProcessRegionView" : { + "type" : "object", + "description" : "Settings to configure the region where you wish to store your archived data.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSDataProcessRegionView", + "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "DataProtectionSettings" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to update the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail" ] + }, + "DataProtectionSettings20231001" : { + "type" : "object", + "properties" : { + "authorizedEmail" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the user who authorized to update the Backup Compliance Policy settings." + }, + "authorizedUserFirstName" : { + "type" : "string", + "description" : "First name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated the Backup Compliance Policy settings." + }, + "copyProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false." + }, + "encryptionAtRestEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "onDemandPolicyItem" : { + "$ref" : "#/components/schemas/BackupComplianceOnDemandPolicyItem" + }, + "pitEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy." + }, + "scheduledPolicyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one scheduled policy.", + "items" : { + "$ref" : "#/components/schemas/BackupComplianceScheduledPolicyItem" + } + }, + "state" : { + "type" : "string", + "description" : "Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "enum" : [ "ACTIVE", "ENABLING", "UPDATING", "DISABLING" ], + "readOnly" : true + }, + "updatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + }, + "updatedUser" : { + "type" : "string", + "format" : "email", + "description" : "Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.", + "readOnly" : true + } + }, + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ] + }, + "DatabaseInheritedRole" : { + "type" : "object", + "description" : "Role inherited from another context for this database user.", + "externalDocs" : { + "description" : "Built-in MongoDB Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + }, + "properties" : { + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which someone grants the action to one MongoDB user." + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the role inherited. Set this value to `admin` for every role except `read` or `readWrite`.", + "externalDocs" : { + "description" : "MongoDB Built-In Roles", + "url" : "https://docs.mongodb.com/manual/reference/built-in-roles/" + } + } + }, + "required" : [ "db", "role" ], + "title" : "Inherited Role" + }, + "DatabasePermittedNamespaceResource" : { + "type" : "object", + "description" : "Namespace to which this database user has access.", + "externalDocs" : { + "description" : "Cluster Resources", + "url" : "https://docs.mongodb.com/manual/reference/resource-document/#cluster-resource" + }, + "properties" : { + "cluster" : { + "type" : "boolean", + "description" : "Flag that indicates whether to grant the action on the cluster resource. If `true`, MongoDB Cloud ignores the **actions.resources.collection** and **actions.resources.db** parameters." + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection on which you grant the action to one MongoDB user. If you don't set this parameter, you grant the action to all collections in the database specified in the **actions.resources.db** parameter. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + }, + "db" : { + "type" : "string", + "description" : "Human-readable label that identifies the database on which you grant the action to one MongoDB user. If you set `\"actions.resources.cluster\" : true`, MongoDB Cloud ignores this parameter." + } + }, + "required" : [ "cluster", "collection", "db" ], + "title" : "Permitted Namespace" + }, + "DatabasePrivilegeAction" : { + "type" : "object", + "description" : "Privilege action that the role grants.", + "properties" : { + "action" : { + "type" : "string", + "description" : "Human-readable label that identifies the privilege action.", + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "CHANGE_STREAM", "COLL_MOD", "COMPACT", "CONVERT_TO_CAPPED", "DROP_DATABASE", "DROP_INDEX", "RE_INDEX", "RENAME_COLLECTION_SAME_DB", "SET_USER_WRITE_BLOCK", "BYPASS_USER_WRITE_BLOCK", "LIST_SESSIONS", "KILL_ANY_SESSION", "COLL_STATS", "CONN_POOL_STATS", "DB_HASH", "DB_STATS", "GET_CMD_LINE_OPTS", "GET_LOG", "GET_PARAMETER", "GET_SHARD_MAP", "HOST_INFO", "IN_PROG", "LIST_DATABASES", "LIST_COLLECTIONS", "LIST_INDEXES", "LIST_SHARDS", "NET_STAT", "REPL_SET_GET_CONFIG", "REPL_SET_GET_STATUS", "SERVER_STATUS", "VALIDATE", "SHARDING_STATE", "TOP", "SQL_GET_SCHEMA", "SQL_SET_SCHEMA", "VIEW_ALL_HISTORY", "OUT_TO_S3", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "GET_STREAM_PROCESSOR", "CREATE_STREAM_PROCESSOR", "PROCESS_STREAM_PROCESSOR", "START_STREAM_PROCESSOR", "STOP_STREAM_PROCESSOR", "DROP_STREAM_PROCESSOR", "SAMPLE_STREAM_PROCESSOR", "LIST_STREAM_PROCESSORS", "LIST_CONNECTIONS", "STREAM_PROCESSOR_STATS" ] + }, + "resources" : { + "type" : "array", + "description" : "List of resources on which you grant the action.", + "items" : { + "$ref" : "#/components/schemas/DatabasePermittedNamespaceResource" + } + } + }, + "required" : [ "action" ], + "title" : "Database Privilege Action" + }, + "DatabaseRollingIndexRequest" : { + "type" : "object", + "properties" : { + "collation" : { + "$ref" : "#/components/schemas/Collation" + }, + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection for which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.", + "writeOnly" : true + }, + "keys" : { + "type" : "array", + "description" : "List that contains one or more objects that describe the parameters that you want to index.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "description" : "Key-value pair that sets the parameter to index as the key and the type of index as its value. To create a [multikey index](https://docs.mongodb.com/manual/core/index-multikey/), list each parameter in its own object within this array.", + "externalDocs" : { + "description" : "Index Types", + "url" : "https://docs.mongodb.com/manual/indexes/#index-types" + }, + "maxProperties" : 1, + "minProperties" : 1, + "writeOnly" : true + }, + "writeOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/IndexOptions" + } + }, + "required" : [ "collection", "db" ] + }, + "DatabaseUserRole" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Collection on which this role applies." + }, + "databaseName" : { + "type" : "string", + "description" : "Database to which the user is granted access privileges." + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.", + "enum" : [ "atlasAdmin", "backup", "clusterMonitor", "dbAdmin", "dbAdminAnyDatabase", "enableSharding", "read", "readAnyDatabase", "readWrite", "readWriteAnyDatabase", "" ] + } + }, + "required" : [ "databaseName", "roleName" ], + "title" : "Database User Role" + }, + "Datadog" : { + "type" : "object", + "description" : "Details to integrate one Datadog account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "apiKey" ], + "title" : "DATADOG" + }, + "DatadogNotification" : { + "type" : "object", + "description" : "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "datadogApiKey" : { + "type" : "string", + "description" : "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************a23c" + }, + "datadogRegion" : { + "type" : "string", + "default" : "US", + "description" : "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "DATADOG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Datadog Notification" + }, + "DatasetRetentionPolicy" : { + "type" : "object", + "description" : "Dataset Retention Policy for a Scheduled Data Lake Pipeline.", + "properties" : { + "lastModifiedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when retention policy was last modified.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Quantity of time in which the Data Lake Pipeline measures dataset retention.", + "enum" : [ "DAYS", "WEEKS", "MONTHS" ] + }, + "value" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the amount of days, weeks, or months that the Data Lake Pipeline will retain datasets.", + "minimum" : 1 + } + }, + "required" : [ "units", "value" ], + "title" : "Dataset Retention Policy" + }, + "DateCriteriaView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CriteriaView" + }, { + "type" : "object", + "properties" : { + "dateField" : { + "type" : "string", + "description" : "Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the **expireAfterDays** parameter. Set this parameter when you set `\"criteria.type\" : \"DATE\"`." + }, + "dateFormat" : { + "type" : "string", + "default" : "ISODATE", + "description" : "Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "expireAfterDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days after the value in the **criteria.dateField** when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set **\"criteria.type\" : \"DATE\"**." + } + } + } ], + "description" : "**DATE criteria.type**.", + "title" : "Archival Criteria" + }, + "DedicatedHardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + } ], + "properties" : { + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DedicatedHardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "DefaultAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Any Other Alert Configurations" + }, + "DefaultAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Other alerts which don't have extra details beside of basic one.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Incident that triggered this alert.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + } ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Any Other Alerts" + }, + "DefaultEventViewForNdsGroup" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultEventViewForOrg" : { + "type" : "object", + "description" : "Other events which don't have extra details beside of basic one.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "object", + "description" : "Unique identifier of event type.", + "oneOf" : [ { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + } ] + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Any Other Events" + }, + "DefaultLimit" : { + "type" : "object", + "description" : "Details of user managed limits", + "properties" : { + "currentUsage" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount that indicates the current usage of the limit.", + "readOnly" : true + }, + "defaultLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Default value of the limit.", + "readOnly" : true + }, + "maximumLimit" : { + "type" : "integer", + "format" : "int64", + "description" : "Maximum value of the limit.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the user-managed limit to modify.", + "readOnly" : true + }, + "value" : { + "type" : "integer", + "format" : "int64", + "description" : "Amount to set the limit to." + } + }, + "required" : [ "name", "value" ], + "title" : "Default Limit" + }, + "DefaultScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + } ], + "required" : [ "type" ] + }, + "DeleteCopiedBackups" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica setclusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "DeleteCopiedBackups20240805" : { + "type" : "object", + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "Destination" : { + "type" : "object", + "description" : "Document that describes the destination of the migration.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "hostnameSchemaType" : { + "type" : "string", + "default" : "PUBLIC", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] + }, + "privateLinkId" : { + "type" : "string", + "description" : "Represents the endpoint to use when the host schema type is `PRIVATE_LINK`." + } + }, + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ] + }, + "DiskBackupApiPolicyItem" : { + "type" : "object", + "description" : "Specifications for one policy.", + "properties" : { + "frequencyInterval" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "enum" : [ "days", "weeks", "months", "years" ] + }, + "retentionValue" : { + "type" : "integer", + "format" : "int32", + "description" : "Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.\n\nFor example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item." + } + }, + "required" : [ "frequencyInterval", "frequencyType", "retentionUnit", "retentionValue" ] + }, + "DiskBackupCopySetting" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + } + } + }, + "DiskBackupCopySetting20240805" : { + "type" : "object", + "description" : "Copy setting item in the desired backup policy.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores the snapshot copy.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "frequencies" : { + "type" : "array", + "description" : "List that describes which types of snapshots to copy.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "shouldCopyOplogs" : { + "type" : "boolean", + "description" : "Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores." + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the replicationSpecs array [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "required" : [ "zoneId" ] + }, + "DiskBackupExportJob" : { + "type" : "object", + "properties" : { + "components" : { + "type" : "array", + "description" : "Information on the export job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportMember" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "exportStatus" : { + "$ref" : "#/components/schemas/ExportStatus" + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefix" : { + "type" : "string", + "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "state" : { + "type" : "string", + "description" : "State of the export job.", + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], + "readOnly" : true + } + }, + "required" : [ "exportBucketId" ] + }, + "DiskBackupExportJobRequest" : { + "type" : "object", + "properties" : { + "customData" : { + "type" : "array", + "description" : "Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "exportBucketId", "snapshotId" ] + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupOnDemandSnapshotRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\" : \"onDemand\"`." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "retentionInDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**.", + "minimum" : 1 + } + } + }, + "DiskBackupReplicaSet" : { + "type" : "object", + "description" : "Details of the replica set snapshot that MongoDB Cloud created.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "copyRegions" : { + "type" : "array", + "description" : "List that identifies the regions to which MongoDB Cloud copies the snapshot.", + "items" : { + "type" : "string" + }, + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Replica Set Snapshot" + }, + "DiskBackupRestoreMember" : { + "type" : "object", + "properties" : { + "downloadUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the replica set on the sharded cluster.", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "type" : "object", + "description" : "Details of the sharded cluster snapshot that MongoDB Cloud created.", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "enum" : [ "EMBEDDED", "DEDICATED" ], + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "members" : { + "type" : "array", + "description" : "List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `\"type\" : \"SHARDED_CLUSTER\"`.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshotMember" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotIds" : { + "type" : "array", + "description" : "List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `\"type\": \"SHARDED_CLUSTER\"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + }, + "title" : "Sharded Cluster Snapshot" + }, + "DiskBackupShardedClusterSnapshotMember" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when `\"type\": \"replicaSet\"`.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider", "id", "replicaSetName" ] + }, + "DiskBackupSnapshot" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "propertyName" : "type" + }, + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `\"status\": \"onDemand\"`.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "masterKeyUUID" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `\"encryptionEnabled\" : true`.", + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains unique identifiers for the policy items.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup at time of snapshot.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that categorizes the cluster as a replica set or sharded cluster.", + "enum" : [ "replicaSet", "shardedCluster" ], + "readOnly" : true + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ] + }, + "DiskBackupSnapshotAzureExportBucket" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "serviceUrl" : { + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net", + "maxLength" : 55, + "minLength" : 33 + }, + "tenantId" : { + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ] + }, + "DiskBackupSnapshotExportBucket" : { + "type" : "object", + "description" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + }, + "propertyName" : "cloudProvider" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "bucketName" : { + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container that the role is authorized to export to.", + "example" : "export-bucket", + "maxLength" : 63, + "minLength" : 3 + }, + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider that Snapshots will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "bucketName", "cloudProvider" ] + }, + "DiskBackupSnapshotRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "components" : { + "type" : "array", + "description" : "Information on the restore job for each replica set in the sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + }, + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`. Required for `automated` and `pointInTime` restore types.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**. Required for `automated` and `pointInTime` restore types.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType" ] + }, + "DiskBackupSnapshotSchedule" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskBackupSnapshotSchedule20240805" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "copySettings" : { + "type" : "array", + "description" : "List that contains a document for each copy setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20240805" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20240805" + }, + "writeOnly" : true + }, + "export" : { + "$ref" : "#/components/schemas/AutoExportPolicyView" + }, + "extraRetentionSettings" : { + "type" : "array", + "description" : "List that contains a document for each extra retention setting item in the desired backup policy.", + "items" : { + "$ref" : "#/components/schemas/ExtraRetentionSetting" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nextSnapshot" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "Rules set for this backup schedule.", + "items" : { + "$ref" : "#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy" + }, + "maxItems" : 1 + }, + "referenceHourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot." + }, + "referenceMinuteOfHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot." + }, + "restoreWindowDays" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only." + }, + "updateSnapshots" : { + "type" : "boolean", + "description" : "Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.", + "writeOnly" : true + }, + "useOrgAndGroupNamesInExportPrefix" : { + "type" : "boolean", + "description" : "Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket." + } + } + }, + "DiskGBAutoScaling" : { + "type" : "object", + "description" : "Setting that enables disk auto-scaling.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling." + } + } + }, + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "EARPrivateEndpoint" : { + "type" : "object", + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ], + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "type" : "string", + "description" : "Microsoft Azure Regions.", + "enum" : [ "US_CENTRAL", "US_EAST", "US_EAST_2", "US_NORTH_CENTRAL", "US_WEST", "US_SOUTH_CENTRAL", "EUROPE_NORTH", "EUROPE_WEST", "US_WEST_CENTRAL", "US_WEST_2", "US_WEST_3", "CANADA_EAST", "CANADA_CENTRAL", "BRAZIL_SOUTH", "BRAZIL_SOUTHEAST", "AUSTRALIA_CENTRAL", "AUSTRALIA_CENTRAL_2", "AUSTRALIA_EAST", "AUSTRALIA_SOUTH_EAST", "GERMANY_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ], + "title" : "Azure Regions" + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "readOnly" : true + } + }, + "title" : "Encryption At Rest Private Endpoint" + }, + "EmailNotification" : { + "type" : "object", + "description" : "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "EMAIL" ] + } + }, + "required" : [ "typeName" ], + "title" : "Email Notification" + }, + "EncryptionAtRest" : { + "type" : "object", + "properties" : { + "awsKms" : { + "$ref" : "#/components/schemas/AWSKMSConfiguration" + }, + "azureKeyVault" : { + "$ref" : "#/components/schemas/AzureKeyVault" + }, + "googleCloudKms" : { + "$ref" : "#/components/schemas/GoogleCloudKMS" + } + } + }, + "EncryptionAtRestPrivateEndpointRequest" : { + "type" : "object", + "description" : "Create or delete private endpoints from the specified regions list.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider name.", + "enum" : [ "AZURE" ] + }, + "regions" : { + "type" : "array", + "description" : "List of regions.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "Encryption At Rest Private Endpoints setup." + }, + "EncryptionKeyAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/EncryptionKeyEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Encryption Key Alert Configuration" + }, + "EncryptionKeyEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "example" : "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", + "title" : "Encryption Event Types" + }, + "EndpointService" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSPrivateLinkConnection", + "AZURE" : "#/components/schemas/AzurePrivateLinkConnection", + "GCP" : "#/components/schemas/GCPEndpointService" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "EventTypeDetails" : { + "type" : "object", + "description" : "A singular type of event", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "title" : "Event type details" + }, + "EventTypeForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "INSIDE_REALM_METRIC_THRESHOLD", "OUTSIDE_REALM_METRIC_THRESHOLD", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED" ], + "title" : "App Services Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_INDEXING_ENABLED", "AUTO_INDEXING_DISABLED", "AUTO_INDEXING_INDEX_BUILD_SUBMITTED", "AUTO_INDEXING_SLOW_INDEX_BUILD", "AUTO_INDEXING_STALLED_INDEX_BUILD", "AUTO_INDEXING_FAILED_INDEX_BUILD", "AUTO_INDEXING_COMPLETED_INDEX_BUILD", "AUTO_INDEXING_STARTED_INDEX_BUILD" ], + "title" : "Auto Indexing Event Types" + }, { + "type" : "string", + "enum" : [ "AUTOMATION_CONFIG_PUBLISHED_AUDIT" ], + "title" : "Automation Config Event Types" + }, { + "type" : "string", + "enum" : [ "PEER_CREATED", "PEER_DELETED", "PEER_UPDATED" ], + "title" : "AWS Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "AZURE_PEER_CREATED", "AZURE_PEER_UPDATED", "AZURE_PEER_ACTIVE", "AZURE_PEER_DELETED" ], + "title" : "Azure Peer Network Audit Types" + }, { + "type" : "string", + "enum" : [ "CREDIT_CARD_CURRENT", "CREDIT_CARD_ABOUT_TO_EXPIRE", "PENDING_INVOICE_UNDER_THRESHOLD", "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_UNDER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CONNECTION_GET_DATABASES", "CLUSTER_CONNECTION_GET_DATABASE_COLLECTIONS", "CLUSTER_CONNECTION_GET_DATABASE_NAMESPACES", "CLUSTER_CONNECTION_GET_NAMESPACES_WITH_UUID", "CLUSTER_CONNECTION_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ], + "title" : "Cluster Connection Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_MONGOS_IS_PRESENT", "CLUSTER_MONGOS_IS_MISSING" ], + "title" : "Cluster Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_BEHIND", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_PREV_SNAPSHOT_OLD", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_BEHIND", "CPS_OPLOG_CAUGHT_UP" ], + "title" : "Cps Backup Event Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER", "DATA_EXPLORER_CRUD_ATTEMPT", "DATA_EXPLORER_CRUD_ERROR", "DATA_EXPLORER_CRUD" ], + "title" : "Data Explorer Accessed Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED" ], + "title" : "CPS Backup Compliance Policy Event Types" + }, { + "type" : "string", + "enum" : [ "CPS_RESTORE_REQUESTED_AUDIT", "CPS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_START_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_SUCCESS_AUDIT", "CPS_SNAPSHOT_FASTER_RESTORES_FAILED_AUDIT", "CPS_SNAPSHOT_DELETED_AUDIT", "CPS_SNAPSHOT_RETENTION_MODIFIED_AUDIT", "CPS_SNAPSHOT_IN_PROGRESS_AUDIT", "CPS_SNAPSHOT_COMPLETED_AUDIT", "CPS_ON_DEMAND_SNAPSHOT_REQUESTED", "CPS_OPLOG_CAUGHT_UP_AUDIT", "CPS_OPLOG_BEHIND_AUDIT" ], + "title" : "Disk Backup Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_ENCRYPTION_KEY_ROTATED", "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_ROTATED", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_ROTATED", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_VALID", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_VALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_VALID", "GCP_ENCRYPTION_KEY_INVALID" ], + "title" : "Encryption Event Types" + }, { + "type" : "string", + "enum" : [ "BUCKET_CREATED_AUDIT", "BUCKET_DELETED_AUDIT" ], + "title" : "Export Bucket Audit Types" + }, { + "type" : "string", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "title" : "FTS Index Audit Types" + }, { + "type" : "string", + "enum" : [ "GCP_PEER_CREATED", "GCP_PEER_DELETED", "GCP_PEER_UPDATED", "GCP_PEER_ACTIVE", "GCP_PEER_INACTIVE" ], + "title" : "GCP Peer Vpc Audit Types" + }, { + "type" : "string", + "enum" : [ "DATA_EXPLORER_ENABLED", "DATA_EXPLORER_DISABLED", "CREDIT_CARD_ADDED", "CREDIT_CARD_UPDATED", "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED", "GROUP_TEMPORARILY_ACTIVATED", "GROUP_ACTIVATED", "GROUP_LOCKED", "GROUP_SUSPENDED", "GROUP_FLUSHED", "GROUP_NAME_CHANGED", "GROUP_CHARTS_ACTIVATION_REQUESTED", "GROUP_CHARTS_ACTIVATED", "GROUP_CHARTS_UPGRADED", "GROUP_CHARTS_RESET" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "PAID_IN_FULL", "DELINQUENT", "ALL_USERS_HAVE_MULTI_FACTOR_AUTH", "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_RESTORED" ], + "title" : "Group Event Types" + }, { + "type" : "string", + "enum" : [ "INTEGRATION_CONFIGURED", "INTEGRATION_REMOVED" ], + "title" : "Group Integration Event Types" + }, { + "type" : "string", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "title" : "Host Event Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "title" : "Host Metric Event Types" + }, { + "type" : "string", + "enum" : [ "ROLLING_INDEX_FAILED_INDEX_BUILD", "ROLLING_INDEX_SUCCESS_INDEX_BUILD", "INDEX_FAILED_INDEX_BUILD", "INDEX_SUCCESS_INDEX_BUILD" ], + "title" : "Index Build Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "DB_CHECK_SUBMITTED", "DB_CHECK_UPDATED", "CLUSTER_SAMPLED_FOR_DB_CHECK", "DB_CHECK_SCHEDULED_FOR_CLUSTER", "DB_CHECK_DEFERRED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DB_CHECK" ], + "title" : "NDS DB Check Audit Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_SAMPLED_FOR_DATA_VALIDATION", "DATA_VALIDATION_SUBMITTED_FOR_CLUSTER", "CLUSTER_OPTED_OUT_OF_DATA_VALIDATION" ], + "title" : "NDS Data Validation Audit Types" + }, { + "type" : "string", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_NO_LONGER_NEEDED" ], + "title" : "NDS Maintenance Window Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_AUTO_SCALING_INITIATED", "SERVERLESS_VERTICAL_SCALING_INITIATED", "SERVERLESS_HORIZONTAL_SCALING_INITIATED", "SERVERLESS_MTM_DRAIN_REQUESTED", "SERVERLESS_MTM_DRAIN_INITIATED", "SERVERLESS_MTM_DRAIN_COMPLETED", "SERVERLESS_MTM_DRAIN_STOPPED" ], + "title" : "NDS Serverless Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "title" : "NDS Serverless Instance Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "title" : "NDS Auto Scaling Audit Types" + }, { + "type" : "string", + "enum" : [ "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_CREATED", "TENANT_ENDPOINT_SERVICE_CREATED", "TENANT_ENDPOINT_SERVICE_AVAILABLE", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETE_REQUESTED", "TENANT_ENDPOINT_SERVICE_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_DELETED", "TENANT_ENDPOINT_SERVICE_DEPLOYMENT_NUM_DESIRED_ENDPOINT_SERVICES_INCREASED" ], + "title" : "NDS Tenant Endpoint Service Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_RESOLVED", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "title" : "NDS x509 User Auth Event Types" + }, { + "type" : "string", + "enum" : [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_RESOLVED", "ONLINE_ARCHIVE_UP_TO_DATE", "ONLINE_ARCHIVE_DATA_EXPIRATION_RESOLVED", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], + "title" : "Online Archive Event Types" + }, { + "type" : "string", + "enum" : [ "ENDPOINT_SERVICE_CREATED", "ENDPOINT_SERVICE_DELETED", "INTERFACE_ENDPOINT_CREATED", "INTERFACE_ENDPOINT_DELETED", "INTERFACE_ENDPOINT_PATCHED" ], + "title" : "Private Link Audit Types" + }, { + "type" : "string", + "enum" : [ "PROACTIVE_OPERATION_EVENT_LOGGED" ], + "title" : "Proactive Operation Event Types" + }, { + "type" : "string", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "title" : "ReplicaSet Event Types" + }, { + "type" : "string", + "enum" : [ "SERVERLESS_DEPLOYMENT_CREATED", "SERVERLESS_DEPLOYMENT_DELETED", "SERVERLESS_DEPLOYMENT_UPDATED", "SERVERLESS_DEPLOYMENT_INSTANCE_REPLACED", "SERVERLESS_DEPLOYMENT_INSTANCE_REBOOTED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_LINKED", "SERVERLESS_DEPLOYMENT_ENDPOINT_SERVICE_UNLINKED", "SERVERLESS_DEPLOYMENT_ENVOY_INSTANCE_UIS_KEYS_ROTATED" ], + "title" : "Serverless Deployment Audit Types" + }, { + "type" : "string", + "enum" : [ "INSIDE_SERVERLESS_METRIC_THRESHOLD", "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "title" : "Serverless Event Types" + }, { + "type" : "string", + "enum" : [ "SETUP_SERVERLESS_INITIATED" ], + "title" : "Setup Serverless Audit Types" + }, { + "type" : "string", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "title" : "Streams Event Types" + }, { + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "title" : "Stream Processor Event Types" + }, { + "type" : "string", + "enum" : [ "CASE_CREATED" ], + "title" : "Support Case Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "TENANT_SNAPSHOT_STARTED_AUDIT", "TENANT_SNAPSHOT_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DELETED_AUDIT", "TENANT_RESTORE_REQUESTED_AUDIT", "TENANT_RESTORE_COMPLETED_AUDIT", "TENANT_SNAPSHOT_DOWNLOAD_REQUESTED_AUDIT" ], + "title" : "Tenant Backup Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "title" : "Version Audit Types" + }, { + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventTypeForOrg" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "ALERT_ACKNOWLEDGED_AUDIT", "ALERT_UNACKNOWLEDGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "ALERT_CONFIG_DISABLED_AUDIT", "ALERT_CONFIG_ENABLED_AUDIT", "ALERT_CONFIG_ADDED_AUDIT", "ALERT_CONFIG_DELETED_AUDIT", "ALERT_CONFIG_CHANGED_AUDIT" ], + "title" : "Alert Audit Types" + }, { + "type" : "string", + "enum" : [ "API_KEY_CREATED", "API_KEY_DELETED", "API_KEY_ACCESS_LIST_ENTRY_ADDED", "API_KEY_ACCESS_LIST_ENTRY_DELETED", "API_KEY_ROLES_CHANGED", "API_KEY_DESCRIPTION_CHANGED", "API_KEY_ADDED_TO_GROUP", "API_KEY_REMOVED_FROM_GROUP", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "API_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "API User Event Types" + }, { + "type" : "string", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, { + "type" : "string", + "enum" : [ "CHARGE_SUCCEEDED", "CHARGE_FAILED", "CHARGE_PROCESSING", "CHARGE_PENDING_REVERSAL", "BRAINTREE_CHARGE_FAILED", "INVOICE_CLOSED", "CHECK_PAYMENT_RECEIVED", "WIRE_TRANSFER_PAYMENT_RECEIVED", "DISCOUNT_APPLIED", "CREDIT_ISSUED", "CREDIT_PULLED_FWD", "CREDIT_END_DATE_MODIFIED", "PROMO_CODE_APPLIED", "PAYMENT_FORGIVEN", "REFUND_ISSUED", "ACCOUNT_DOWNGRADED", "ACCOUNT_UPGRADED", "ACCOUNT_MODIFIED", "SUPPORT_PLAN_ACTIVATED", "SUPPORT_PLAN_CANCELLED", "SUPPORT_PLAN_CANCELLATION_SCHEDULED", "INITIATE_SALESFORCE_SERVICE_CLOUD_SYNC", "INVOICE_ADDRESS_CHANGED", "INVOICE_ADDRESS_ADDED", "PREPAID_PLAN_ACTIVATED", "ELASTIC_INVOICING_MODE_ACTIVATED", "ELASTIC_INVOICING_MODE_DEACTIVATED", "TERMINATE_PAID_SERVICES", "BILLING_EMAIL_ADDRESS_ADDED", "BILLING_EMAIL_ADDRESS_CHANGED", "BILLING_EMAIL_ADDRESS_REMOVED", "AWS_BILLING_ACCOUNT_CREDIT_ISSUED", "GCP_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_SFOLID_MODIFIED", "PREPAID_PLAN_MODIFIED", "AWS_USAGE_REPORTED", "AZURE_USAGE_REPORTED", "GCP_USAGE_REPORTED", "BECAME_PAYING_ORG", "NEW_LINKED_ORG", "UNLINKED_ORG", "ORG_LINKED_TO_PAYING_ORG", "ORG_UNLINKED_FROM_PAYING_ORG", "ORG_UNLINK_REQUESTED", "ORG_UNLINK_CANCELLED", "PAYMENT_UPDATED_THROUGH_API", "AZURE_BILLING_ACCOUNT_CREDIT_ISSUED", "CREDIT_START_DATE_MODIFIED", "CREDIT_ELASTIC_INVOICING_MODIFIED", "CREDIT_TYPE_MODIFIED", "CREDIT_AMOUNT_CENTS_MODIFIED", "CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED", "CREDIT_TOTAL_BILLED_CENTS_MODIFIED", "CREDIT_AWS_CUSTOMER_ID_MODIFIED", "CREDIT_AWS_PRODUCT_CODE_MODIFIED", "CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED", "CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED", "CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED", "TARGETED_REBILL_EXECUTED", "LEGACY_REBILL_EXECUTED", "EVERGREEN_DEAL_CANCELLED", "GRACE_PERIOD_ACTIVATED", "GRACE_PERIOD_NO_LONGER_IN_EFFECT", "PENDING_DEAL_ACTIVATION_ADDED", "PENDING_DEAL_ACTIVATION_CANCELED", "PENDING_DEAL_APPLIED", "PENDING_DEAL_ACTIVATION_FAILED", "EVERGREEN_PRIORITY_MODIFIED" ], + "title" : "Billing Event Types" + }, { + "type" : "string", + "enum" : [ "FEDERATION_SETTINGS_CREATED", "FEDERATION_SETTINGS_DELETED", "FEDERATION_SETTINGS_UPDATED", "IDENTITY_PROVIDER_CREATED", "IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DELETED", "IDENTITY_PROVIDER_ACTIVATED", "OIDC_IDENTITY_PROVIDER_UPDATED", "IDENTITY_PROVIDER_DEACTIVATED", "IDENTITY_PROVIDER_JWKS_REVOKED", "OIDC_IDENTITY_PROVIDER_ENABLED", "OIDC_IDENTITY_PROVIDER_DISABLED", "DOMAINS_ASSOCIATED", "DOMAIN_CREATED", "DOMAIN_DELETED", "DOMAIN_VERIFIED", "ORG_SETTINGS_CONFIGURED", "ORG_SETTINGS_UPDATED", "ORG_SETTINGS_DELETED", "RESTRICT_ORG_MEMBERSHIP_ENABLED", "RESTRICT_ORG_MEMBERSHIP_DISABLED", "ROLE_MAPPING_CREATED", "ROLE_MAPPING_UPDATED", "ROLE_MAPPING_DELETED" ], + "title" : "Federation Settings Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_DELETED", "GROUP_CREATED", "GROUP_MOVED" ], + "title" : "Group Audit Types" + }, { + "type" : "string", + "enum" : [ "MLAB_MIGRATION_COMPLETED", "MLAB_MIGRATION_TARGET_CLUSTER_CREATED", "MLAB_MIGRATION_DATABASE_USERS_IMPORTED", "MLAB_MIGRATION_IP_WHITELIST_IMPORTED", "MLAB_MIGRATION_TARGET_CLUSTER_SET", "MLAB_MIGRATION_DATABASE_RENAMED", "MLAB_MIGRATION_LIVE_IMPORT_STARTED", "MLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVER", "MLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETE", "MLAB_MIGRATION_LIVE_IMPORT_ERROR", "MLAB_MIGRATION_LIVE_IMPORT_CANCELLED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTED", "MLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPED", "MLAB_MIGRATION_DUMP_AND_RESTORE_STARTED", "MLAB_MIGRATION_SUPPORT_PLAN_SELECTED", "MLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT" ], + "title" : "Mlab Migration Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "title" : "NDS Audit Types" + }, { + "type" : "string", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "title" : "Org Event Types" + }, { + "type" : "string", + "enum" : [ "AWS_SELF_SERVE_ACCOUNT_LINKED", "AWS_SELF_SERVE_ACCOUNT_LINK_PENDING", "AWS_SELF_SERVE_ACCOUNT_CANCELLED", "AWS_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINK_PENDING", "GCP_SELF_SERVE_ACCOUNT_LINK_FAILED", "AZURE_SELF_SERVE_ACCOUNT_LINKED", "AZURE_SELF_SERVE_ACCOUNT_LINK_PENDING", "AZURE_SELF_SERVE_ACCOUNT_CANCELLED", "AZURE_SELF_SERVE_ACCOUNT_LINK_FAILED", "GCP_SELF_SERVE_ACCOUNT_LINKED", "GCP_SELF_SERVE_ACCOUNT_CANCELLED" ], + "title" : "Partner Event Types" + }, { + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ], + "title" : "Support Event Types" + }, { + "type" : "string", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "title" : "Team Event Types" + }, { + "type" : "string", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "title" : "User Event Types" + }, { + "type" : "string", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "title" : "Resource Event Types" + } ] + }, + "EventViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServiceAccountGroupEvents" + }, { + "$ref" : "#/components/schemas/AutomationConfigEventView" + }, { + "$ref" : "#/components/schemas/AppServiceEventView" + }, { + "$ref" : "#/components/schemas/BillingEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/DataExplorerAccessedEventView" + }, { + "$ref" : "#/components/schemas/FTSIndexAuditView" + }, { + "$ref" : "#/components/schemas/HostEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricEvent" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSAutoScalingAuditViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditView" + }, { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditView" + }, { + "$ref" : "#/components/schemas/ForNdsGroup" + }, { + "$ref" : "#/components/schemas/TeamEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/UserEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamsEventViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorEventViewForNdsGroup" + } ] + }, + "EventViewForOrg" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AlertAudit" + }, { + "$ref" : "#/components/schemas/AlertConfigAudit" + }, { + "$ref" : "#/components/schemas/ApiUserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ServiceAccountOrgEvents" + }, { + "$ref" : "#/components/schemas/BillingEventViewForOrg" + }, { + "$ref" : "#/components/schemas/NDSAuditViewForOrg" + }, { + "$ref" : "#/components/schemas/OrgEventViewForOrg" + }, { + "$ref" : "#/components/schemas/TeamEvent" + }, { + "$ref" : "#/components/schemas/UserEventViewForOrg" + }, { + "$ref" : "#/components/schemas/ResourceEventViewForOrg" + } ] + }, + "ExampleResourceResponse20230101" : { + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "data" ] + }, + "ExampleResourceResponse20230201" : { + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "description" ] + }, + "ExportStatus" : { + "type" : "object", + "description" : "State of the export job for the collections on the replica set only.", + "properties" : { + "exportedCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of collections on the replica set that MongoDB Cloud exported.", + "readOnly" : true + }, + "totalCollections" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of collections on the replica set to export.", + "readOnly" : true + } + } + }, + "ExtraRetentionSetting" : { + "type" : "object", + "description" : "extra retention setting item in the desired backup policy.", + "properties" : { + "frequencyType" : { + "type" : "string", + "description" : "The frequency type for the extra retention settings for the cluster.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + }, + "retentionDays" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of extra retention days for the cluster." + } + } + }, + "FTSIndexAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "example" : "FTS_INDEX_CREATED", + "title" : "FTS Index Audit Types" + }, + "FTSIndexAuditView" : { + "type" : "object", + "description" : "FTS index audit indicates any activities about search index.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "FTS Index Audits" + }, + "FTSMetric" : { + "type" : "object", + "description" : "Measurement of one Atlas Search status when MongoDB Atlas received this request.", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies this Atlas Search hardware, status, or index measurement.", + "enum" : [ "INDEX_SIZE_ON_DISK", "NUMBER_OF_DELETES", "NUMBER_OF_ERROR_QUERIES", "NUMBER_OF_GETMORE_COMMANDS", "NUMBER_OF_INDEX_FIELDS", "NUMBER_OF_INSERTS", "NUMBER_OF_SUCCESS_QUERIES", "NUMBER_OF_UPDATES", "REPLICATION_LAG", "TOTAL_NUMBER_OF_QUERIES", "FTS_DISK_USAGE", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "FTS_PROCESS_RESIDENT_MEMORY", "FTS_PROCESS_SHARED_MEMORY", "FTS_PROCESS_VIRTUAL_MEMORY", "JVM_CURRENT_MEMORY", "JVM_MAX_MEMORY", "PAGE_FAULTS" ], + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Unit of measurement that applies to this Atlas Search metric.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "KILOBYTES", "MEGABYTES", "MEGABYTES_PER_SECOND", "MILLISECONDS", "MILLISECONDS_LOGSCALE", "PERCENT", "SCALAR", "SCALAR_PER_SECOND", "SECONDS" ], + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "metricName", "units" ] + }, + "FederatedUser" : { + "type" : "object", + "description" : "MongoDB Cloud user linked to this federated authentication.", + "properties" : { + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user linked to the federated organization." + }, + "federationSettingsId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the federation to which this MongoDB Cloud user belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user." + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user." + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "emailAddress", "federationSettingsId", "firstName", "lastName" ], + "title" : "Federated User" + }, + "FederationIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + } + }, + "FederationOidcIdentityProvider" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ], + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ], + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkforceIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "clientId" : { + "type" : "string", + "description" : "Client identifier that is assigned to an application by the Identity Provider." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestedScopes" : { + "type" : "array", + "description" : "Scopes that MongoDB applications will request from the authorization endpoint.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKFORCE" + }, + "FederationOidcWorkloadIdentityProvider" : { + "type" : "object", + "properties" : { + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "OIDC WORKLOAD" + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "audience" : { + "type" : "string", + "description" : "Identifier of the intended recipient of the token." + }, + "authorizationType" : { + "type" : "string", + "description" : "Indicates whether authorization is granted based on group membership or user ID.", + "enum" : [ "GROUP", "USER" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "groupsClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains IdP Group IDs in the token." + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "title" : "OIDC WORKLOAD" + }, + "FederationSamlIdentityProvider" : { + "type" : "object", + "properties" : { + "acsUrl" : { + "type" : "string", + "description" : "URL that points to where to send the SAML response." + }, + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "associatedOrgs" : { + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "uniqueItems" : true + }, + "audienceUri" : { + "type" : "string", + "description" : "Unique string that identifies the intended audience of the SAML assertion." + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was created on.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL." + }, + "oktaIdpId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider.", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfo" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request." + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + }, + "updatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date that the identity provider was last updated on.", + "readOnly" : true + } + }, + "required" : [ "id", "oktaIdpId" ], + "title" : "SAML" + }, + "FederationSamlIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "associatedDomains" : { + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "type" : "string", + "description" : "Human-readable label that identifies the identity provider.", + "maxLength" : 50, + "minLength" : 1 + }, + "idpType" : { + "type" : "string", + "description" : "String enum that indicates the type of the identity provider. Default is WORKFORCE.", + "enum" : [ "WORKFORCE", "WORKLOAD" ] + }, + "issuerUri" : { + "type" : "string", + "description" : "Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "requestBinding" : { + "type" : "string", + "description" : "SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "enum" : [ "SHA-1", "SHA-256" ] + }, + "slug" : { + "type" : "string", + "description" : "Custom SSO Url for the identity provider." + }, + "ssoDebugEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the identity provider has SSO debug enabled." + }, + "ssoUrl" : { + "type" : "string", + "description" : "URL that points to the receiver of the SAML authentication request.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "required" : [ "ssoDebugEnabled" ], + "title" : "SAML" + }, + "FieldTransformation" : { + "type" : "object", + "description" : "Field Transformations during ingestion of a Data Lake Pipeline.", + "properties" : { + "field" : { + "type" : "string", + "description" : "Key in the document." + }, + "type" : { + "type" : "string", + "description" : "Type of transformation applied during the export of the namespace in a Data Lake Pipeline.", + "enum" : [ "EXCLUDE" ] + } + }, + "title" : "Field Transformation" + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Unique string that identifies the GCP project in which MongoDB Cloud clusters in this network peering container exist. The response returns **null** if no clusters exist in this network peering container.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network in which MongoDB Cloud clusters in this network peering container exist. MongoDB Cloud returns **null** if no clusters exist in this network peering container.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "readOnly" : true + }, + "regions" : { + "type" : "array", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "items" : { + "type" : "string", + "description" : "List of GCP regions to which you want to deploy this MongoDB Cloud network peering container. In this MongoDB Cloud project, you can deploy clusters only to the GCP regions in this list. To deploy MongoDB Cloud clusters to other GCP regions, create additional projects.", + "enum" : [ "ASIA_EAST_2", "ASIA_NORTHEAST_2", "ASIA_NORTHEAST_3", "ASIA_SOUTH_1", "ASIA_SOUTH_2", "ASIA_SOUTHEAST_2", "AUSTRALIA_SOUTHEAST_1", "AUSTRALIA_SOUTHEAST_2", "CENTRAL_US", "EASTERN_ASIA_PACIFIC", "EASTERN_US", "EUROPE_CENTRAL_2", "EUROPE_NORTH_1", "EUROPE_WEST_2", "EUROPE_WEST_3", "EUROPE_WEST_4", "EUROPE_WEST_6", "EUROPE_WEST_10", "EUROPE_WEST_12", "MIDDLE_EAST_CENTRAL_1", "MIDDLE_EAST_CENTRAL_2", "MIDDLE_EAST_WEST_1", "NORTH_AMERICA_NORTHEAST_1", "NORTH_AMERICA_NORTHEAST_2", "NORTHEASTERN_ASIA_PACIFIC", "SOUTH_AMERICA_EAST_1", "SOUTH_AMERICA_WEST_1", "SOUTHEASTERN_ASIA_PACIFIC", "US_EAST_4", "US_EAST_5", "US_WEST_2", "US_WEST_3", "US_WEST_4", "US_SOUTH_1", "WESTERN_EUROPE", "WESTERN_US" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "type" : "string", + "description" : "Minimum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "endpointGroupNames" : { + "type" : "array", + "description" : "List of Google Cloud network endpoint groups that corresponds to the Private Service Connect endpoint service.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "type" : "string", + "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." + } + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Cloud provider region that manages this Private Endpoint Service.", + "readOnly" : true + }, + "serviceAttachmentNames" : { + "type" : "array", + "description" : "List of Uniform Resource Locators (URLs) that identifies endpoints that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "externalDocs" : { + "description" : "Google Cloud Private Service Connect Service Attachments", + "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + }, + "items" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that identifies one endpoint that MongoDB Cloud can use to access one Google Cloud Service across a Google Cloud Virtual Private Connection (VPC) network.", + "pattern" : "https:\\/\\/([a-z0-9\\.]+)+\\.[a-z]{2,}(\\/[a-z0-9\\-]+)+\\/projects\\/p-[a-z0-9]+\\/regions\\/[a-z\\-0-9]+\\/serviceAttachments\\/[a-z0-9\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "gcpProjectId" : { + "type" : "string", + "description" : "Human-readable label that identifies the GCP project that contains the network that you want to peer with the MongoDB Cloud VPC.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "providerName" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested network peering connection.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "status" : { + "type" : "string", + "description" : "State of the network peering connection at the time you made the request.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "description" : "List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "selfManagedSharding" : { + "type" : "boolean", + "description" : "Boolean that controls which management mode the Global Cluster is operating under. If this parameter is true Self-Managed Sharding is enabled and users are in control of the zone sharding within the Global Cluster. If this parameter is false Atlas-Managed Sharding is enabled and Atlas is control of zone sharding within the Global Cluster.", + "readOnly" : true + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled encryption at rest for the specified project. To disable encryption at rest using customer key management and remove the configuration details, pass only this parameter with a value of `false`." + }, + "keyVersionResourceID" : { + "type" : "string", + "description" : "Resource path that displays the key version resource ID for your Google Cloud KMS.", + "example" : "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" + }, + "serviceAccountKey" : { + "type" : "string", + "description" : "JavaScript Object Notation (JSON) object that contains the Google Cloud Key Management Service (KMS). Format the JSON as a string and not as an object.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/AppServiceMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/BillingThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ClusterAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/CpsBackupThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/EncryptionKeyAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ReplicaSetThresholdAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/ServerlessMetricAlertConfigViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "GroupMaintenanceWindow" : { + "type" : "object", + "properties" : { + "autoDeferOnceEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them." + }, + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "One-based integer that represents the day of the week that the maintenance window starts.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "maximum" : 7, + "minimum" : 1 + }, + "hourOfDay" : { + "type" : "integer", + "format" : "int32", + "description" : "Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use `0` for midnight and `12` for noon.", + "maximum" : 23, + "minimum" : 0 + }, + "numberOfDeferrals" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of times the current maintenance event for this project has been deferred.", + "readOnly" : true + }, + "startASAP" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to `false` after MongoDB Cloud completes maintenance." + } + }, + "required" : [ "dayOfWeek" ] + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "readOnly" : true + }, + "destinationOrgPublicApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "maxLength" : 8, + "minLength" : 8, + "readOnly" : true + } + } + }, + "GroupNotification" : { + "type" : "object", + "description" : "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "GROUP" ] + } + }, + "required" : [ "typeName" ], + "title" : "Group Notification" + }, + "GroupPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "GroupRole" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRole" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include project-level roles.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "GroupService" : { + "type" : "object", + "description" : "List of IP addresses in a project categorized by services.", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Group Service IP Addresses" + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Roles assigned to the Service Account group.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "GroupServiceAccountRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "Group access roles.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + } + } + }, + "GroupServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Project roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Project roles associated with the service account.", + "enum" : [ "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the project.", + "properties" : { + "isCollectDatabaseSpecificsStatisticsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to collect database-specific metrics for the specified project." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + } + }, + "GroupUpdate" : { + "type" : "object", + "description" : "Request view to update the group.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://www.mongodb.com/docs/atlas/tags" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + } + }, + "HardwareSpec" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec" + } ] + }, + "HardwareSpec20240805" : { + "type" : "object", + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20240805" + } ], + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + } + } + }, + "HipChatNotification" : { + "type" : "object", + "description" : "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notificationToken" : { + "type" : "string", + "description" : "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "************************************1234" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roomName" : { + "type" : "string", + "description" : "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", + "example" : "test room" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "HIP_CHAT" ] + } + }, + "required" : [ "typeName" ], + "title" : "HipChat Notification" + }, + "HostAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Alert Configuration" + }, + "HostAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Host alert notifies about activities on mongod host.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Alerts" + }, + "HostEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "AUTO_CREATED_INDEX_AUDIT", "ATTEMPT_KILLOP_AUDIT", "ATTEMPT_KILLSESSION_AUDIT", "HOST_UP", "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_RECOVERED_OOM", "HOST_MONGOT_CRASHING_OOM", "HOST_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "example" : "HOST_DOWN", + "title" : "Host Event Types" + }, + "HostEventViewForNdsGroup" : { + "type" : "object", + "description" : "Host event identifies different activities about mongod host.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Events" + }, + "HostMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an host against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/HostMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "$ref" : "#/components/schemas/MatcherHostType" + } + }, + "required" : [ "fieldName", "operator" ], + "title" : "Matchers" + }, + "HostMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "example" : "HOSTNAME", + "title" : "Host Matcher Fields" + }, + "HostMetricAlert" : { + "type" : "object", + "description" : "Host Metric Alert notifies about changes of measurements or metrics for mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricAlertView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricAlertView", + "ASSERT_USER" : "#/components/schemas/RawMetricAlertView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricAlertView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricAlertView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricAlertView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricAlertView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricAlertView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricAlertView", + "CONNECTIONS" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricAlertView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricAlertView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricAlertView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricAlertView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricAlertView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricAlertView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricAlertView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricAlertView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricAlertView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricAlertView", + "JOURNALING_MB" : "#/components/schemas/DataMetricAlertView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricAlertView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricAlertView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricAlertView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricAlertView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricAlertView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricAlertView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricAlertView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricAlertView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricAlertView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricAlertView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricAlertView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricAlertView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricAlertView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricAlertView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricAlertView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricAlertView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricAlertView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricAlertView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricAlertView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricAlertView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricAlertView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricAlertView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricAlertView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricAlertView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Host Metric Alerts" + }, + "HostMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Host Metric Alert Configuration" + }, + "HostMetricEvent" : { + "type" : "object", + "description" : "Host Metric Event reflects different measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricEventView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricEventView", + "ASSERT_USER" : "#/components/schemas/RawMetricEventView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricEventView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricEventView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricEventView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricEventView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricEventView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricEventView", + "CONNECTIONS" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricEventView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricEventView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricEventView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricEventView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricEventView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricEventView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricEventView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricEventView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricEventView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricEventView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricEventView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricEventView", + "JOURNALING_MB" : "#/components/schemas/DataMetricEventView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricEventView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_UTILIZATION_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricEventView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricEventView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricEventView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricEventView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricEventView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricEventView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricEventView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricEventView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricEventView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricEventView", + "OPLOG_REPLICATION_LAG_TIME" : "#/components/schemas/TimeMetricEventView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricEventView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricEventView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricEventView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricEventView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricEventView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricEventView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricEventView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricEventView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricEventView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricEventView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricEventView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricEventView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricEventView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricEventView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricEventView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricEventView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Host Metric Events" + }, + "HostMetricEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "INSIDE_METRIC_THRESHOLD", "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_METRIC_THRESHOLD", + "title" : "Host Metric Event Types" + }, + "HostMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", + "discriminator" : { + "mapping" : { + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_REGULAR" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Host Metric Threshold" + }, + "HostMetricValue" : { + "type" : "object", + "description" : "Value of the metric that triggered the alert. The resource returns this parameter for alerts of events impacting hosts.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity in **currentValue.number**. This can be an element of time, storage capacity, and the like. This metric triggered the alert.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Inbound Control Plane IP Addresses By Cloud Provider" + }, + "IndexOptions" : { + "type" : "object", + "description" : "One or more settings that determine how the MongoDB Cloud creates this MongoDB index.", + "externalDocs" : { + "description" : "Index Options", + "url" : "https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options" + }, + "properties" : { + "2dsphereIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Index version number applied to the 2dsphere index. MongoDB 3.2 and later use version 3. Use this option to override the default version number. This option applies to the **2dsphere** index type only." + }, + "background" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB should build the index in the background. This applies to MongoDB databases running feature compatibility version 4.0 or earlier. MongoDB databases running FCV 4.2 or later build indexes using an optimized build process. This process holds the exclusive lock only at the beginning and end of the build process. The rest of the build process yields to interleaving read and write operations. MongoDB databases running FCV 4.2 or later ignore this option. This option applies to all index types." + }, + "bits" : { + "type" : "integer", + "format" : "int32", + "default" : 26, + "description" : "Number of precision applied to the stored geohash value of the location data. This option applies to the **2d** index type only." + }, + "bucketSize" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of units within which to group the location values. You could group in the same bucket those location values within the specified number of units to each other. This option applies to the geoHaystack index type only.\n\nMongoDB 5.0 removed geoHaystack Indexes and the `geoSearch` command." + }, + "columnstoreProjection" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "description" : "The columnstoreProjection document allows to include or exclude subschemas schema. One cannot combine inclusion and exclusion statements. Accordingly, the can be either of the following:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 or false to exclude the field and recursively all fields it is a prefix of from the index." + }, + "default_language" : { + "type" : "string", + "default" : "english", + "description" : "Human language that determines the list of stop words and the rules for the stemmer and tokenizer. This option accepts the supported languages using its name in lowercase english or the ISO 639-2 code. If you set this parameter to `\"none\"`, then the text search uses simple tokenization with no list of stop words and no stemming. This option applies to the **text** index type only." + }, + "expireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of seconds that MongoDB retains documents in a Time To Live (TTL) index." + }, + "hidden" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that determines whether the index is hidden from the query planner. A hidden index is not evaluated as part of the query plan selection." + }, + "language_override" : { + "type" : "string", + "default" : "language", + "description" : "Human-readable label that identifies the document parameter that contains the override language for the document. This option applies to the **text** index type only." + }, + "max" : { + "type" : "integer", + "format" : "int32", + "default" : 180, + "description" : "Upper inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "min" : { + "type" : "integer", + "format" : "int32", + "default" : -180, + "description" : "Lower inclusive boundary to limit the longitude and latitude values. This option applies to the 2d index type only." + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. This option applies to all index types." + }, + "partialFilterExpression" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "sparse" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the index references documents that only have the specified parameter. These indexes use less space but behave differently in some situations like when sorting. The following index types default to sparse and ignore this option: `2dsphere`, `2d`, `geoHaystack`, `text`.\n\nCompound indexes that includes one or more indexes with `2dsphere` keys alongside other key types, only the `2dsphere` index parameters determine which documents the index references. If you run MongoDB 3.2 or later, use partial indexes. This option applies to all index types." + }, + "storageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "textIndexVersion" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Version applied to this text index. MongoDB 3.2 and later use version `3`. Use this option to override the default version number. This option applies to the **text** index type only." + }, + "weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + } + }, + "writeOnly" : true + }, + "IngestionPipelineRun" : { + "type" : "object", + "description" : "Run details of a Data Lake Pipeline.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "backupFrequencyType" : { + "type" : "string", + "description" : "Backup schedule interval of the Data Lake Pipeline.", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ], + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run was created.", + "readOnly" : true + }, + "datasetName" : { + "type" : "string", + "description" : "Human-readable label that identifies the dataset that Atlas generates during this pipeline run. You can use this dataset as a `dataSource` in a Federated Database collection.", + "example" : "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates the last time that the pipeline run was updated.", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ], + "readOnly" : true + }, + "pipelineId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "scheduledDeletionDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp that indicates when the pipeline run will expire and its dataset will be deleted.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot of a cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "State of the pipeline run.", + "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED", "DATASET_DELETED" ], + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PipelineRunStats" + } + }, + "title" : "Data Lake Pipeline Run" + }, + "IngestionSink" : { + "type" : "object", + "description" : "Ingestion destination of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "DLS" : "#/components/schemas/DLSIngestionSink" + }, + "propertyName" : "type" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion destination of this Data Lake Pipeline.", + "enum" : [ "DLS" ], + "readOnly" : true + } + }, + "title" : "Ingestion Destination" + }, + "IngestionSource" : { + "type" : "object", + "description" : "Ingestion Source of a Data Lake Pipeline.", + "discriminator" : { + "mapping" : { + "ON_DEMAND_CPS" : "#/components/schemas/OnDemandCpsSnapshotSource", + "PERIODIC_CPS" : "#/components/schemas/PeriodicCpsSnapshotSource" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/components/schemas/PeriodicCpsSnapshotSource" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of ingestion source of this Data Lake Pipeline.", + "enum" : [ "PERIODIC_CPS", "ON_DEMAND_CPS" ] + } + }, + "title" : "Ingestion Source" + }, + "InvoiceLineItem" : { + "type" : "object", + "description" : "One service included in this invoice.", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster that incurred the charge.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "discountCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "endDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated to this line item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "note" : { + "type" : "string", + "description" : "Comment that applies to this line item.", + "readOnly" : true + }, + "percentDiscount" : { + "type" : "number", + "format" : "float", + "description" : "Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.", + "readOnly" : true + }, + "quantity" : { + "type" : "number", + "format" : "double", + "description" : "Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.", + "readOnly" : true + }, + "sku" : { + "type" : "string", + "description" : "Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.", + "enum" : [ "CLASSIC_BACKUP_OPLOG", "CLASSIC_BACKUP_STORAGE", "CLASSIC_BACKUP_SNAPSHOT_CREATE", "CLASSIC_BACKUP_DAILY_MINIMUM", "CLASSIC_BACKUP_FREE_TIER", "CLASSIC_COUPON", "BACKUP_STORAGE_FREE_TIER", "BACKUP_STORAGE", "FLEX_CONSULTING", "CLOUD_MANAGER_CLASSIC", "CLOUD_MANAGER_BASIC_FREE_TIER", "CLOUD_MANAGER_BASIC", "CLOUD_MANAGER_PREMIUM", "CLOUD_MANAGER_FREE_TIER", "CLOUD_MANAGER_STANDARD_FREE_TIER", "CLOUD_MANAGER_STANDARD_ANNUAL", "CLOUD_MANAGER_STANDARD", "CLOUD_MANAGER_FREE_TRIAL", "ATLAS_INSTANCE_M0", "ATLAS_INSTANCE_M2", "ATLAS_INSTANCE_M5", "ATLAS_AWS_INSTANCE_M10", "ATLAS_AWS_INSTANCE_M20", "ATLAS_AWS_INSTANCE_M30", "ATLAS_AWS_INSTANCE_M40", "ATLAS_AWS_INSTANCE_M50", "ATLAS_AWS_INSTANCE_M60", "ATLAS_AWS_INSTANCE_M80", "ATLAS_AWS_INSTANCE_M100", "ATLAS_AWS_INSTANCE_M140", "ATLAS_AWS_INSTANCE_M200", "ATLAS_AWS_INSTANCE_M300", "ATLAS_AWS_INSTANCE_M40_LOW_CPU", "ATLAS_AWS_INSTANCE_M50_LOW_CPU", "ATLAS_AWS_INSTANCE_M60_LOW_CPU", "ATLAS_AWS_INSTANCE_M80_LOW_CPU", "ATLAS_AWS_INSTANCE_M200_LOW_CPU", "ATLAS_AWS_INSTANCE_M300_LOW_CPU", "ATLAS_AWS_INSTANCE_M400_LOW_CPU", "ATLAS_AWS_INSTANCE_M700_LOW_CPU", "ATLAS_AWS_INSTANCE_M40_NVME", "ATLAS_AWS_INSTANCE_M50_NVME", "ATLAS_AWS_INSTANCE_M60_NVME", "ATLAS_AWS_INSTANCE_M80_NVME", "ATLAS_AWS_INSTANCE_M200_NVME", "ATLAS_AWS_INSTANCE_M400_NVME", "ATLAS_AWS_INSTANCE_M10_PAUSED", "ATLAS_AWS_INSTANCE_M20_PAUSED", "ATLAS_AWS_INSTANCE_M30_PAUSED", "ATLAS_AWS_INSTANCE_M40_PAUSED", "ATLAS_AWS_INSTANCE_M50_PAUSED", "ATLAS_AWS_INSTANCE_M60_PAUSED", "ATLAS_AWS_INSTANCE_M80_PAUSED", "ATLAS_AWS_INSTANCE_M100_PAUSED", "ATLAS_AWS_INSTANCE_M140_PAUSED", "ATLAS_AWS_INSTANCE_M200_PAUSED", "ATLAS_AWS_INSTANCE_M300_PAUSED", "ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED", "ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME", "ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME", "ATLAS_AWS_STORAGE_PROVISIONED", "ATLAS_AWS_STORAGE_STANDARD", "ATLAS_AWS_STORAGE_STANDARD_GP3", "ATLAS_AWS_STORAGE_IOPS", "ATLAS_AWS_DATA_TRANSFER_SAME_REGION", "ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION", "ATLAS_AWS_DATA_TRANSFER_INTERNET", "ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS", "ATLAS_AWS_PRIVATE_ENDPOINT", "ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD", "ATLAS_GCP_INSTANCE_M10", "ATLAS_GCP_INSTANCE_M20", "ATLAS_GCP_INSTANCE_M30", "ATLAS_GCP_INSTANCE_M40", "ATLAS_GCP_INSTANCE_M50", "ATLAS_GCP_INSTANCE_M60", "ATLAS_GCP_INSTANCE_M80", "ATLAS_GCP_INSTANCE_M140", "ATLAS_GCP_INSTANCE_M200", "ATLAS_GCP_INSTANCE_M250", "ATLAS_GCP_INSTANCE_M300", "ATLAS_GCP_INSTANCE_M400", "ATLAS_GCP_INSTANCE_M40_LOW_CPU", "ATLAS_GCP_INSTANCE_M50_LOW_CPU", "ATLAS_GCP_INSTANCE_M60_LOW_CPU", "ATLAS_GCP_INSTANCE_M80_LOW_CPU", "ATLAS_GCP_INSTANCE_M200_LOW_CPU", "ATLAS_GCP_INSTANCE_M300_LOW_CPU", "ATLAS_GCP_INSTANCE_M400_LOW_CPU", "ATLAS_GCP_INSTANCE_M600_LOW_CPU", "ATLAS_GCP_INSTANCE_M10_PAUSED", "ATLAS_GCP_INSTANCE_M20_PAUSED", "ATLAS_GCP_INSTANCE_M30_PAUSED", "ATLAS_GCP_INSTANCE_M40_PAUSED", "ATLAS_GCP_INSTANCE_M50_PAUSED", "ATLAS_GCP_INSTANCE_M60_PAUSED", "ATLAS_GCP_INSTANCE_M80_PAUSED", "ATLAS_GCP_INSTANCE_M140_PAUSED", "ATLAS_GCP_INSTANCE_M200_PAUSED", "ATLAS_GCP_INSTANCE_M250_PAUSED", "ATLAS_GCP_INSTANCE_M300_PAUSED", "ATLAS_GCP_INSTANCE_M400_PAUSED", "ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED", "ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED", "ATLAS_GCP_DATA_TRANSFER_INTERNET", "ATLAS_GCP_STORAGE_SSD", "ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT", "ATLAS_GCP_DATA_TRANSFER_INTER_ZONE", "ATLAS_GCP_DATA_TRANSFER_INTER_REGION", "ATLAS_GCP_DATA_TRANSFER_GOOGLE", "ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE", "ATLAS_GCP_BACKUP_DOWNLOAD_VM", "ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_GCP_PRIVATE_ENDPOINT", "ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER", "ATLAS_AZURE_INSTANCE_M10", "ATLAS_AZURE_INSTANCE_M20", "ATLAS_AZURE_INSTANCE_M30", "ATLAS_AZURE_INSTANCE_M40", "ATLAS_AZURE_INSTANCE_M50", "ATLAS_AZURE_INSTANCE_M60", "ATLAS_AZURE_INSTANCE_M80", "ATLAS_AZURE_INSTANCE_M90", "ATLAS_AZURE_INSTANCE_M200", "ATLAS_AZURE_INSTANCE_R40", "ATLAS_AZURE_INSTANCE_R50", "ATLAS_AZURE_INSTANCE_R60", "ATLAS_AZURE_INSTANCE_R80", "ATLAS_AZURE_INSTANCE_R200", "ATLAS_AZURE_INSTANCE_R300", "ATLAS_AZURE_INSTANCE_R400", "ATLAS_AZURE_INSTANCE_M60_NVME", "ATLAS_AZURE_INSTANCE_M80_NVME", "ATLAS_AZURE_INSTANCE_M200_NVME", "ATLAS_AZURE_INSTANCE_M300_NVME", "ATLAS_AZURE_INSTANCE_M400_NVME", "ATLAS_AZURE_INSTANCE_M600_NVME", "ATLAS_AZURE_INSTANCE_M10_PAUSED", "ATLAS_AZURE_INSTANCE_M20_PAUSED", "ATLAS_AZURE_INSTANCE_M30_PAUSED", "ATLAS_AZURE_INSTANCE_M40_PAUSED", "ATLAS_AZURE_INSTANCE_M50_PAUSED", "ATLAS_AZURE_INSTANCE_M60_PAUSED", "ATLAS_AZURE_INSTANCE_M80_PAUSED", "ATLAS_AZURE_INSTANCE_M90_PAUSED", "ATLAS_AZURE_INSTANCE_M200_PAUSED", "ATLAS_AZURE_INSTANCE_R40_PAUSED", "ATLAS_AZURE_INSTANCE_R50_PAUSED", "ATLAS_AZURE_INSTANCE_R60_PAUSED", "ATLAS_AZURE_INSTANCE_R80_PAUSED", "ATLAS_AZURE_INSTANCE_R200_PAUSED", "ATLAS_AZURE_INSTANCE_R300_PAUSED", "ATLAS_AZURE_INSTANCE_R400_PAUSED", "ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD", "ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD", "ATLAS_AZURE_STORAGE_P2", "ATLAS_AZURE_STORAGE_P3", "ATLAS_AZURE_STORAGE_P4", "ATLAS_AZURE_STORAGE_P6", "ATLAS_AZURE_STORAGE_P10", "ATLAS_AZURE_STORAGE_P15", "ATLAS_AZURE_STORAGE_P20", "ATLAS_AZURE_STORAGE_P30", "ATLAS_AZURE_STORAGE_P40", "ATLAS_AZURE_STORAGE_P50", "ATLAS_AZURE_DATA_TRANSFER", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN", "ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN", "ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT", "ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT", "ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50", "ATLAS_AZURE_STANDARD_STORAGE", "ATLAS_AZURE_EXTENDED_STANDARD_IOPS", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE", "ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS", "ATLAS_BI_CONNECTOR", "ATLAS_ADVANCED_SECURITY", "ATLAS_ENTERPRISE_AUDITING", "ATLAS_FREE_SUPPORT", "ATLAS_SUPPORT", "STITCH_DATA_DOWNLOADED_FREE_TIER", "STITCH_DATA_DOWNLOADED", "STITCH_COMPUTE_FREE_TIER", "STITCH_COMPUTE", "CREDIT", "MINIMUM_CHARGE", "CHARTS_DATA_DOWNLOADED_FREE_TIER", "CHARTS_DATA_DOWNLOADED", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET", "ATLAS_DATA_LAKE_AWS_DATA_SCANNED", "ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AWS_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT", "ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION", "ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET", "ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_AZURE_DATA_LAKE_STORAGE", "ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS", "ATLAS_NDS_GCP_DATA_LAKE_STORAGE", "ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_AZURE_OBJECT_STORAGE", "ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE", "ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS", "ATLAS_NDS_GCP_OBJECT_STORAGE", "ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE", "ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AWS_PIT_RESTORE_STORAGE", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_GCP_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER", "ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE", "ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS", "ATLAS_NDS_AWS_OBJECT_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40", "ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60", "ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_RPU", "ATLAS_NDS_AWS_SERVERLESS_WPU", "ATLAS_NDS_AWS_SERVERLESS_STORAGE", "ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_GCP_SERVERLESS_RPU", "ATLAS_NDS_GCP_SERVERLESS_WPU", "ATLAS_NDS_GCP_SERVERLESS_STORAGE", "ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET", "ATLAS_NDS_AZURE_SERVERLESS_RPU", "ATLAS_NDS_AZURE_SERVERLESS_WPU", "ATLAS_NDS_AZURE_SERVERLESS_STORAGE", "ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP", "ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION", "ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET", "REALM_APP_REQUESTS_FREE_TIER", "REALM_APP_REQUESTS", "REALM_APP_COMPUTE_FREE_TIER", "REALM_APP_COMPUTE", "REALM_APP_SYNC_FREE_TIER", "REALM_APP_SYNC", "REALM_APP_DATA_TRANSFER_FREE_TIER", "REALM_APP_DATA_TRANSFER", "GCP_SNAPSHOT_COPY_DISK", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30", "ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50", "ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER", "ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING" ], + "readOnly" : true + }, + "startDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "stitchAppName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Atlas App Services application associated with this line item.", + "externalDocs" : { + "description" : "Create a new Atlas App Service", + "url" : "https://www.mongodb.com/docs/atlas/app-services/manage-apps/create/create-with-ui/" + }, + "readOnly" : true + }, + "tags" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "items" : { + "type" : "string", + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "A map of key-value pairs corresponding to the tags associated with the line item resource.", + "readOnly" : true + }, + "tierLowerBound" : { + "type" : "number", + "format" : "double", + "description" : "Lower bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierLowerBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "tierUpperBound" : { + "type" : "number", + "format" : "double", + "description" : "Upper bound for usage amount range in current SKU tier. \n\n**NOTE**: **lineItems[n].tierUpperBound** appears only if your **lineItems[n].sku** is tiered.", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "format" : "int64", + "description" : "Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as **unitPriceDollars** × **quantity** × 100.", + "readOnly" : true + }, + "unit" : { + "type" : "string", + "description" : "Element used to express what **quantity** this line item measures. This value can be elements of time, storage capacity, and the like.", + "readOnly" : true + }, + "unitPriceDollars" : { + "type" : "number", + "format" : "double", + "description" : "Value per **unit** for this line item expressed in US Dollars.", + "readOnly" : true + } + }, + "title" : "Line Item" + }, + "LDAPSecuritySettings" : { + "type" : "object", + "description" : "Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.", + "properties" : { + "authenticationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authenticate using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authorizationEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether users can authorize access to MongoDB Cloud resources using an Lightweight Directory Access Protocol (LDAP) host." + }, + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud runs to obtain the LDAP groups associated with the authenticated user. MongoDB Cloud uses this parameter only for user authorization. Use the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query according to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base" + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "Port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + }, + "userToDNMapping" : { + "type" : "array", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } + } + }, + "title" : "LDAP Security Settings" + }, + "LDAPVerifyConnectivityJobRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project associated with this Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "request" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + }, + "requestId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this request to verify an Lightweight Directory Access Protocol (LDAP) configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the status of the Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration.", + "enum" : [ "FAIL", "PENDING", "SUCCESS" ], + "readOnly" : true + }, + "validations" : { + "type" : "array", + "description" : "List that contains the validation messages related to the verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details. The list contains a document for each test that MongoDB Cloud runs. MongoDB Cloud stops running tests after the first failure.", + "items" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestValidation" + }, + "readOnly" : true + } + } + }, + "LDAPVerifyConnectivityJobRequestParams" : { + "type" : "object", + "description" : "Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not return the **bindPassword**.", + "properties" : { + "authzQueryTemplate" : { + "type" : "string", + "default" : "{USER}?memberOf?base", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.\n\nUse the `{USER}` placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516).", + "example" : "{USER}?memberOf?base", + "writeOnly" : true + }, + "bindPassword" : { + "type" : "string", + "description" : "Password that MongoDB Cloud uses to authenticate the **bindUsername**.", + "writeOnly" : true + }, + "bindUsername" : { + "type" : "string", + "description" : "Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "externalDocs" : { + "description" : "RFC 2253", + "url" : "https://tools.ietf.org/html/2253" + }, + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$" + }, + "caCertificate" : { + "type" : "string", + "description" : "Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: `\"caCertificate\": \"\"`." + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "default" : 636, + "description" : "IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections." + } + }, + "required" : [ "bindPassword", "bindUsername", "hostname", "port" ] + }, + "LDAPVerifyConnectivityJobRequestValidation" : { + "type" : "object", + "description" : "One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details.", + "properties" : { + "status" : { + "type" : "string", + "description" : "Human-readable string that indicates the result of this verification test.", + "enum" : [ "FAIL", "OK" ], + "readOnly" : true + }, + "validationType" : { + "type" : "string", + "description" : "Human-readable label that identifies this verification test that MongoDB Cloud runs.", + "enum" : [ "AUTHENTICATE", "AUTHORIZATION_ENABLED", "CONNECT", "PARSE_AUTHZ_QUERY", "QUERY_SERVER", "SERVER_SPECIFIED", "TEMPLATE" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "LegacyAtlasCluster" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB cluster.", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "autoScaling" : { + "$ref" : "#/components/schemas/ClusterAutoScalingSettings" + }, + "backupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "biConnector" : { + "$ref" : "#/components/schemas/BiConnector" + }, + "clusterType" : { + "type" : "string", + "description" : "Configuration of nodes that comprise the cluster.", + "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.\n\nWhen set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.\n\nThis setting cannot be changed once the cluster is deployed.", + "externalDocs" : { + "description" : "Creating a Global Cluster", + "url" : "https://dochub.mongodb.org/core/global-cluster-management" + } + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "mongoURI" : { + "type" : "string", + "description" : "Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "mongoURIWithOptions" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 1 + }, + "paused" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster is paused." + }, + "pitEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster uses continuous cloud backups.", + "externalDocs" : { + "description" : "Continuous Cloud Backups", + "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" + } + }, + "providerBackupEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to `true`, the cluster can perform backups. If this and **backupEnabled** are set to `false`, the cluster doesn't use MongoDB Cloud backups." + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ClusterProviderSettings" + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "enum" : [ "ISRGROOTX1" ] + }, + "srvAddress" : { + "type" : "string", + "description" : "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "required" : [ "name" ], + "title" : "Tenant Cluster Upgrade Request" + }, + "LegacyRegionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "LegacyReplicationSpec" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards." + }, + "regionsConfig" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if **clusterType** is `GEOSHARDED`." + } + } + }, + "LessThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "LessThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when less than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Less Than Time Threshold" + }, + "LessThanTimeThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanTimeThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "Link" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "Link_Atlas" : { + "type" : "object", + "properties" : { + "href" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "https://cloud.mongodb.com/api/atlas" + }, + "rel" : { + "type" : "string", + "description" : "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", + "example" : "self" + } + } + }, + "LiveImportAvailableProject" : { + "type" : "object", + "properties" : { + "deployments" : { + "type" : "array", + "description" : "List of clusters that can be migrated to MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "items" : { + "type" : "string", + "description" : "Hostname of MongoDB Agent that you configured to perform a migration." + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this project.", + "maxLength" : 64, + "minLength" : 1, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "name", "projectId" ] + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "sourceGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "status" : { + "type" : "string", + "description" : "State of the specified validation job returned at the time of the request.", + "enum" : [ "PENDING", "SUCCESS", "FAILED" ], + "nullable" : true, + "readOnly" : true + } + } + }, + "LiveMigrationRequest" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "dropEnabled", "source" ] + }, + "LiveMigrationRequest20240530" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "example" : "507f1f77bcf86cd799439011", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of migration hosts used for this migration.", + "items" : { + "type" : "string", + "example" : "vm001.example.com" + }, + "maxItems" : 1, + "minItems" : 1 + }, + "sharding" : { + "$ref" : "#/components/schemas/ShardingRequest" + }, + "source" : { + "$ref" : "#/components/schemas/Source" + } + }, + "required" : [ "destination", "source" ] + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lagTimeSeconds" : { + "type" : "integer", + "format" : "int64", + "description" : "Replication lag between the source and destination clusters. Atlas returns this setting only during an active migration, before the cutover phase.", + "nullable" : true, + "readOnly" : true + }, + "migrationHosts" : { + "type" : "array", + "description" : "List of hosts running MongoDB Agents. These Agents can transfer your MongoDB data between one source and one destination cluster.", + "items" : { + "type" : "string", + "description" : "One host running a MongoDB Agent. This Agent can transfer your MongoDB data between one source and one destination cluster.", + "example" : "vm001.example.com", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + }, + "readOnly" : true + }, + "readyForCutover" : { + "type" : "boolean", + "description" : "Flag that indicates the migrated cluster can be cut over to MongoDB Atlas.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Progress made in migrating one cluster to MongoDB Atlas.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| EXPIRED | MongoDB Atlas prepares to begin the cut over of the migrating cluster when source and destination clusters have almost synchronized. If `\"readyForCutover\" : true`, this synchronization starts a timer of 120 hours. You can extend this timer. If the timer expires, MongoDB Atlas returns this status. |\n| WORKING | The cluster migration to MongoDB Atlas is performing one of the following tasks:
  • Preparing connections to source and destination clusters
  • Replicating data from source to destination
  • Verifying MongoDB Atlas connection settings
  • Stopping replication after the cut over
|\n", + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ], + "readOnly" : true + } + } + }, + "ManagedNamespaces" : { + "type" : "object", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label of the collection to manage for this Global Cluster." + }, + "customShardKey" : { + "type" : "string", + "description" : "Database parameter used to divide the *collection* into shards. Global clusters require a compound shard key. This compound shard key combines the location parameter and the user-selected custom key.", + "readOnly" : true + }, + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." + }, + "isCustomShardKeyHashed" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to `false`, MongoDB Cloud uses ranged sharding.", + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "writeOnly" : true + }, + "isShardKeyUnique" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone [hashed](https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys) the custom shard key. If this parameter returns `false`, this cluster uses [ranged sharding](https://www.mongodb.com/docs/manual/core/ranged-sharding/).", + "writeOnly" : true + }, + "numInitialChunks" : { + "type" : "integer", + "format" : "int64", + "description" : "Minimum number of chunks to create initially when sharding an empty collection with a [hashed shard key](https://www.mongodb.com/docs/manual/core/hashed-sharding/).", + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + }, + "maximum" : 8192, + "writeOnly" : true + }, + "presplitHashedZones" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.", + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "writeOnly" : true + } + }, + "required" : [ "collection", "customShardKey", "db" ] + }, + "MatcherFieldView" : { + "type" : "object", + "oneOf" : [ { + "type" : "string", + "enum" : [ "APPLICATION_ID" ], + "title" : "App Services Metric Matcher Fields" + }, { + "type" : "string", + "enum" : [ "CLUSTER_NAME" ], + "title" : "Cluster Matcher Fields" + }, { + "type" : "string", + "enum" : [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME" ], + "title" : "Host Matcher Fields" + }, { + "type" : "string", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "title" : "Replica Set Matcher Fields" + }, { + "type" : "string", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "title" : "Streams Matcher Fields" + } ] + }, + "MatcherHostType" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "enum" : [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG" ], + "example" : "STANDALONE", + "title" : "Matcher Host Types" + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "MeasurementDiskPartition" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "partitionName" : { + "type" : "string", + "description" : "Human-readable label of the disk or partition to which the measurements apply.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsIndexes" : { + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection.", + "readOnly" : true + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves.", + "readOnly" : true + }, + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "indexIds" : { + "type" : "array", + "description" : "List that contains the Atlas Search index identifiers.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + } + }, + "MeasurementsNonIndex" : { + "type" : "object", + "properties" : { + "end" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to stop retrieving measurements. If you set **end**, you must set **start**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "granularity" : { + "type" : "string", + "description" : "Duration that specifies the interval between measurement data points. The parameter expresses its value in ISO 8601 timestamp format in UTC. If you set this parameter, you must set either **period** or **start** and **end**.", + "enum" : [ "PT1M", "PT5M", "PT1H", "P1D" ], + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project. The project contains MongoDB processes that you want to return. The MongoDB process can be either the `mongod` or `mongos`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hardwareMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search hardware measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "processId" : { + "type" : "string", + "description" : "Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests.", + "example" : "mongodb.example.com:27017", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "readOnly" : true + }, + "start" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that specifies when to start retrieving measurements. If you set **start**, you must set **end**. You can't set this parameter and **period** in the same request. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "statusMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search status measurements.", + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + }, + "readOnly" : true + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "MetricDataPoint" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricDataPoint_Atlas" : { + "type" : "object", + "description" : "value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "properties" : { + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this data point occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "value" : { + "type" : "number", + "description" : "Value that comprises this data point.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "MetricsMeasurement" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MetricsMeasurement_Atlas" : { + "type" : "object", + "properties" : { + "dataPoints" : { + "type" : "array", + "description" : "List that contains the value of, and metadata provided for, one data point generated at a particular moment in time. If no data point exists for a particular moment in time, the `value` parameter returns `null`.", + "items" : { + "$ref" : "#/components/schemas/MetricDataPoint_Atlas" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label of the measurement that this data point covers.", + "readOnly" : true + }, + "units" : { + "type" : "string", + "description" : "Element used to quantify the measurement. The resource returns units of throughput, storage, and time.", + "enum" : [ "BYTES", "BYTES_PER_SECOND", "GIGABYTES", "GIGABYTES_PER_HOUR", "MEGABYTES_PER_SECOND", "MICROSECONDS", "MILLISECONDS", "PERCENT", "SCALAR", "SCALAR_PER_SECOND" ], + "readOnly" : true + } + } + }, + "MicrosoftTeams" : { + "type" : "object", + "description" : "Details to integrate one Microsoft Teams account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Endpoint web address of the Microsoft Teams webhook to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "microsoftTeamsWebhookUrl" ], + "title" : "MICROSOFT_TEAMS" + }, + "MicrosoftTeamsNotification" : { + "type" : "object", + "description" : "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "microsoftTeamsWebhookUrl" : { + "type" : "string", + "description" : "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "MICROSOFT_TEAMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "Microsoft Teams Notification" + }, + "MongoDBAccessLogs" : { + "type" : "object", + "description" : "Authentication attempt, one per object, made against the cluster.", + "properties" : { + "authResult" : { + "type" : "boolean", + "description" : "Flag that indicates whether the response should return successful authentication attempts only." + }, + "authSource" : { + "type" : "string", + "description" : "Database against which someone attempted to authenticate.", + "readOnly" : true + }, + "failureReason" : { + "type" : "string", + "description" : "Reason that the authentication failed. Null if authentication succeeded.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname of the target node that received the authentication attempt.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Internet Protocol address that attempted to authenticate with the database.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "logLine" : { + "type" : "string", + "description" : "Text of the host log concerning the authentication attempt.", + "readOnly" : true + }, + "timestamp" : { + "type" : "string", + "description" : "Date and time when someone made this authentication attempt. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username used to authenticate against the database.", + "readOnly" : true + } + } + }, + "MongoDBAccessLogsList" : { + "type" : "object", + "properties" : { + "accessLogs" : { + "type" : "array", + "description" : "Authentication attempt, one per object, made against the cluster.", + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + }, + "readOnly" : true + } + } + }, + "MonthlyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfMonth" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the month when the scheduled archive starts.", + "maximum" : 31, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "NDSAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "CLUSTER_CREATED", "CLUSTER_RESURRECTED", "CLUSTER_READY", "CLUSTER_UPDATE_SUBMITTED", "CLUSTER_UPDATE_SUBMITTED_INTERNAL", "CLUSTER_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_MONGOT_PROCESS_ARGS_UPDATE_SUBMITTED", "CLUSTER_SERVER_PARAMETERS_UPDATE_SUBMITTED", "CLUSTER_AUTOMATICALLY_PAUSED", "CLUSTER_UPDATE_STARTED", "CLUSTER_UPDATE_STARTED_INTERNAL", "CLUSTER_UPDATE_COMPLETED", "MATERIAL_CLUSTER_UPDATE_COMPLETED_INTERNAL", "CLUSTER_DELETE_SUBMITTED", "CLUSTER_DELETE_SUBMITTED_INTERNAL", "CLUSTER_DELETED", "CLUSTER_IMPORT_STARTED", "CLUSTER_IMPORT_CANCELLED", "CLUSTER_IMPORT_EXPIRED", "CLUSTER_IMPORT_CUTOVER", "CLUSTER_IMPORT_RESTART_REQUESTED", "PROJECT_LIVE_IMPORT_OVERRIDES_ADDED", "PROJECT_LIVE_IMPORT_OVERRIDES_UPDATED", "PROJECT_LIVE_IMPORT_OVERRIDES_DELETED", "CLUSTER_OPLOG_RESIZED", "CLUSTER_INSTANCE_RESTARTED", "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_RESYNC_CLEARED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "CLUSTER_INSTANCE_REPLACED", "CLUSTER_INSTANCE_REPLACE_CLEARED", "CLUSTER_INSTANCE_CONFIG_UPDATED", "CLUSTER_INSTANCE_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "CLUSTER_INSTANCE_ADMIN_BACKUP_SNAPSHOT_REQUESTED", "UPDATE_BUMPER_FILES", "DATA_LAKE_QUERY_LOGS_DOWNLOADED", "FEDERATED_DATABASE_QUERY_LOGS_DOWNLOADED", "ONLINE_ARCHIVE_QUERY_LOGS_DOWNLOADED", "MONGODB_LOGS_DOWNLOADED", "MONGOSQLD_LOGS_DOWNLOADED", "MONGODB_USER_ADDED", "MONGODB_USER_DELETED", "MONGODB_USER_X509_CERT_CREATED", "MONGODB_USER_X509_CERT_REVOKED", "MONGODB_USER_UPDATED", "MONGODB_ROLE_ADDED", "MONGODB_ROLE_DELETED", "MONGODB_ROLE_UPDATED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_ADDED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_REMOVED", "PRIVATE_NETWORK_ENDPOINT_ENTRY_UPDATED", "PLAN_STARTED", "PLAN_COMPLETED", "PLAN_ABANDONED", "PLAN_FAILURE_COUNT_RESET", "PLAN_ASAP_REQUESTED", "INDEPENDENT_SHARD_SCALING_AVAILABLE", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "ATLAS_MAINTENANCE_WINDOW_ADDED", "ATLAS_MAINTENANCE_WINDOW_MODIFIED", "ATLAS_MAINTENANCE_WINDOW_REMOVED", "ATLAS_MAINTENANCE_START_ASAP", "ATLAS_MAINTENANCE_SCHEDULED_FOR_NEXT_WINDOW", "ATLAS_MAINTENANCE_DEFERRED", "ATLAS_MAINTENANCE_AUTO_DEFER_ENABLED", "ATLAS_MAINTENANCE_AUTO_DEFER_DISABLED", "SCHEDULED_MAINTENANCE", "PROJECT_SCHEDULED_MAINTENANCE", "PROJECT_LIMIT_UPDATED", "PROJECT_OPERATIONAL_LIMIT_UPDATED", "PROJECT_ENABLE_EXTENDED_STORAGE_SIZES_UPDATED", "OS_MAINTENANCE", "OS_MAINTENANCE_RESTART", "OS_MAINTENANCE_REPLACEMENT", "FREE_UPGRADE_STARTED", "TEST_FAILOVER_REQUESTED", "USER_SECURITY_SETTINGS_UPDATED", "AUDIT_LOG_CONFIGURATION_UPDATED", "STREAMS_AUDIT_LOG_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_UPDATED", "ENCRYPTION_AT_REST_CONFIGURATION_VALIDATION_FAILED", "NDS_SET_IMAGE_OVERRIDES", "NDS_SET_CHEF_TARBALL_URI", "RESTRICTED_EMPLOYEE_ACCESS_BYPASS", "REVOKED_EMPLOYEE_ACCESS_BYPASS", "DEVICE_SYNC_DEBUG_ACCESS_GRANTED", "DEVICE_SYNC_DEBUG_ACCESS_REVOKED", "DEVICE_SYNC_DEBUG_X509_CERT_CREATED", "QUERY_ENGINE_TENANT_CREATED", "QUERY_ENGINE_TENANT_UPDATED", "QUERY_ENGINE_TENANT_REMOVED", "FEDERATED_DATABASE_CREATED", "FEDERATED_DATABASE_UPDATED", "FEDERATED_DATABASE_REMOVED", "TENANT_CLUSTER_UPGRADE_FROM_MTM", "TENANT_SNAPSHOT_FAILED", "TENANT_RESTORE_FAILED", "SAMPLE_DATASET_LOAD_REQUESTED", "CUSTOMER_X509_CRL_UPDATED", "CONTAINER_SUBNETS_UPDATE_REQUESTED", "CLEAR_UNPROVISIONED_TARGET_GROUPS_REQUESTED", "ONLINE_ARCHIVE_CREATED", "ONLINE_ARCHIVE_DELETED", "ONLINE_ARCHIVE_UPDATED", "ONLINE_ARCHIVE_PAUSE_REQUESTED", "ONLINE_ARCHIVE_PAUSED", "ONLINE_ARCHIVE_ACTIVE", "ONLINE_ARCHIVE_ORPHANED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_ENABLED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_UPDATED", "ONLINE_ARCHIVE_DATA_EXPIRATION_RULE_DISABLED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_ADDED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_DELETED", "CLOUD_PROVIDER_ACCESS_AWS_IAM_ROLE_UPDATED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_ADDED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_DELETED", "CLOUD_PROVIDER_ACCESS_AZURE_SERVICE_PRINCIPAL_UPDATED", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "EXTRA_MAINTENANCE_DEFERRAL_GRANTED", "ADMIN_NOTE_UPDATED", "GROUP_AUTOMATION_CONFIG_PUBLISHED", "CLUSTER_AUTOMATION_CONFIG_PUBLISHED", "SET_ENSURE_CLUSTER_CONNECTIVITY_AFTER_FOR_CLUSTER", "CLUSTER_LINKED_TO_VERCEL", "CLUSTER_UNLINKED_FROM_VERCEL", "INGESTION_PIPELINE_DELETED", "INGESTION_PIPELINE_DESTROYED", "INGESTION_PIPELINE_CREATED", "INGESTION_PIPELINE_UPDATED", "OS_TUNE_FILE_OVERRIDES", "CLUSTER_PREFERRED_CPU_ARCHITECTURE_MODIFIED", "CLUSTER_FORCE_PLANNED", "DATA_PROCESSING_REGION_UPDATED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_STARTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_FAILED_TO_START", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_END_REQUESTED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_COMPLETED", "CLUSTER_REGIONAL_OUTAGE_SIMULATION_CANCELLED_CLUSTER_PAUSE", "UIS_PANICKED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_MAINTENANCE", "DATA_FEDERATION_QUERY_LIMIT_CONFIGURED", "DATA_FEDERATION_QUERY_LIMIT_DELETED", "DATA_API_SETUP_FOR_VERCEL", "ADMIN_CLUSTER_LOCK_UPDATED", "CLUSTER_ROLLING_RESYNC_STARTED", "CLUSTER_ROLLING_RESYNC_COMPLETED", "CLUSTER_ROLLING_RESYNC_FAILED", "NODE_ROLLING_RESYNC_SCHEDULED", "CLUSTER_ROLLING_RESYNC_CANCELED", "CLUSTER_OS_UPDATED", "CLUSTER_INSTANCE_FAMILY_UPDATED", "PUSH_BASED_LOG_EXPORT_ENABLED", "PUSH_BASED_LOG_EXPORT_CONFIGURATION_UPDATED", "PUSH_BASED_LOG_EXPORT_DISABLED", "AZURE_CLUSTER_PREFERRED_STORAGE_TYPE_UPDATED", "CONTAINER_DELETED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_ENABLED", "REGIONALIZED_PRIVATE_ENDPOINT_MODE_DISABLED", "STREAM_TENANT_CREATED", "STREAM_TENANT_UPDATED", "STREAM_TENANT_DELETED", "STREAM_TENANT_CONNECTIONS_LISTED", "STREAM_TENANT_CONNECTION_UPDATED", "STREAM_TENANT_CONNECTION_DELETED", "STREAM_TENANT_CONNECTION_CREATED", "STREAM_TENANT_CONNECTION_VIEWED", "STREAM_TENANT_AUDIT_LOGS", "STREAM_TENANT_AUDIT_LOGS_DELETED", "QUEUED_ADMIN_ACTION_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "example" : "CLUSTER_CREATED", + "title" : "NDS Audit Types" + }, + "NDSAuditTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_LIMIT_UPDATED" ], + "example" : "ORG_LIMIT_UPDATED", + "title" : "NDS Audit Types" + }, + "NDSAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAuditViewForOrg" : { + "type" : "object", + "description" : "NDS audit saving information about atlas cloud provider and other atlas related details.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "dbUserUsername" : { + "type" : "string", + "description" : "The username of the MongoDB User that was created, deleted, or edited.", + "example" : "user1", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAuditTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "whitelistEntry" : { + "type" : "string", + "description" : "Entry in the list of source host addresses that the API key accepts and this event targets.", + "example" : "0.0.0.0", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Audits" + }, + "NDSAutoScalingAuditTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "COMPUTE_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_INITIATED", "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL" ], + "example" : "COMPUTE_AUTO_SCALE_INITIATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "type" : "object", + "description" : "NDS auto scaling audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Auto Scaling Audits" + }, + "NDSNotificationView" : { + "type" : "object", + "description" : "NDS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "severity" : { + "type" : "string", + "description" : "Degree of seriousness given to this notification.", + "enum" : [ "CRITICAL", "ERROR", "WARNING" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "NDS" ] + } + }, + "required" : [ "typeName" ], + "title" : "NDS Notification" + }, + "NDSServerlessInstanceAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVERLESS_INSTANCE_CREATED", "SERVERLESS_INSTANCE_READY", "SERVERLESS_INSTANCE_UPDATE_SUBMITTED", "SERVERLESS_INSTANCE_UPDATE_STARTED", "SERVERLESS_INSTANCE_UPDATE_COMPLETED", "SERVERLESS_INSTANCE_DELETE_SUBMITTED", "SERVERLESS_INSTANCE_DELETED", "SERVERLESS_INSTANCE_BLOCKED", "SERVERLESS_INSTANCE_UNBLOCKED" ], + "example" : "SERVERLESS_INSTANCE_CREATED", + "title" : "NDS Serverless Instance Audit Types" + }, + "NDSServerlessInstanceAuditView" : { + "type" : "object", + "description" : "NDS serverless instance audit identifies any activities around serverless instance.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Serverless Instance Audits" + }, + "NDSTenantEndpointAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TENANT_ENDPOINT_CREATED", "TENANT_ENDPOINT_RESERVED", "TENANT_ENDPOINT_RESERVATION_FAILED", "TENANT_ENDPOINT_UPDATED", "TENANT_ENDPOINT_INITIATING", "TENANT_ENDPOINT_AVAILABLE", "TENANT_ENDPOINT_FAILED", "TENANT_ENDPOINT_DELETING", "TENANT_ENDPOINT_DELETED", "TENANT_ENDPOINT_EXPIRED" ], + "example" : "TENANT_ENDPOINT_CREATED", + "title" : "NDS Auto Scaling Audit Types" + }, + "NDSTenantEndpointAuditView" : { + "type" : "object", + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the endpoint associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSTenantEndpointAuditTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "providerEndpointId" : { + "type" : "string", + "description" : "Unique identification string that the cloud provider uses to identify the private endpoint.", + "example" : "vpce-0d6c248dedef65a25", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "NDS Tenant Endpoint Audits" + }, + "NDSX509UserAuthenticationAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "NDS X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSX509UserAuthenticationEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/LessThanDaysThresholdView" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "NDS X509 User Authentication Alert Configuration" + }, + "NDSX509UserAuthenticationEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], + "example" : "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", + "title" : "NDS x509 User Auth Event Types" + }, + "NamespaceObj" : { + "type" : "object", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "properties" : { + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "type" : { + "type" : "string", + "default" : "collection", + "description" : "Human-readable label that identifies the type of namespace.", + "enum" : [ "collection" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "Namespaces" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List that contains each combination of database, collection, and type on the specified host.", + "items" : { + "$ref" : "#/components/schemas/NamespaceObj" + }, + "readOnly" : true, + "uniqueItems" : true + } + } + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, + "NetworkPermissionEntry" : { + "type" : "object", + "properties" : { + "awsSecurityGroup" : { + "type" : "string", + "description" : "Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set **cidrBlock** or **ipAddress**.", + "pattern" : "^([0-9]*/)?sg-([0-9]*)" + }, + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **ipAddress**.", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + }, + "comment" : { + "type" : "string", + "description" : "Remark that explains the purpose or scope of this IP access list entry.", + "maxLength" : 80 + }, + "deleteAfterDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the IP access list to which you want to add one or more entries.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "IP address that you want to add to the project's IP access list. Your IP access list entry can be one **awsSecurityGroup**, one **cidrBlock**, or one **ipAddress**. Don't set this parameter if you set **awsSecurityGroup** or **cidrBlock**.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "NetworkPermissionEntryStatus" : { + "type" : "object", + "properties" : { + "STATUS" : { + "type" : "string", + "description" : "State of the access list entry when MongoDB Cloud made this request.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `PENDING` | MongoDB Cloud has started to add access list entry. This access list entry may not apply to all cloud providers at the time of this request. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "enum" : [ "PENDING", "FAILED", "ACTIVE" ], + "readOnly" : true + } + }, + "required" : [ "STATUS" ] + }, + "NewRelic" : { + "type" : "object", + "description" : "Details to integrate one New Relic account with one MongoDB Cloud project.\n\n***IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\n\nTo learn more, see the New Relic Plugin EOL Statement. Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "properties" : { + "accountId" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic account.", + "example" : "bcc3c81b344a6030a3935c2527e2216535af7718", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "licenseKey" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**IMPORTANT**: Effective Wednesday, June 16th, 2021, New Relic no longer supports the plugin-based integration with MongoDB. We do not recommend that you sign up for the plugin-based integration.\nTo learn more, see the New Relic Plugin EOL Statement Consider configuring an alternative monitoring integration before June 16th to maintain visibility into your MongoDB deployments.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea", + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$" + }, + "readToken" : { + "type" : "string", + "description" : "Query key used to access your New Relic account.", + "example" : "193c96aee4a3ac640b98634562e2631f17ae0a69" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "NEW_RELIC" ] + }, + "writeToken" : { + "type" : "string", + "description" : "Insert key associated with your New Relic account.", + "example" : "a67b10e5cd7f8fb6a34b501136c409f373edc218" + } + }, + "required" : [ "accountId", "licenseKey", "readToken", "writeToken" ], + "title" : "NEW_RELIC" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." + }, + "NumberMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "NumberMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "NumberMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "NumberMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], + "example" : "COUNT", + "title" : "Number Metric Units" + }, + "NumberMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/NumberMetricUnits" + } + }, + "readOnly" : true, + "title" : "Number Metric Value" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "OnDemandCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "On-Demand Cloud Provider Snapshots as Source for a Data Lake Pipeline.", + "title" : "On-Demand Cloud Provider Snapshot Source" + }, + "OnlineArchiveSchedule" : { + "type" : "object", + "description" : "Regular frequency and duration when archiving process occurs.", + "discriminator" : { + "mapping" : { + "DAILY" : "#/components/schemas/DailyScheduleView", + "DEFAULT" : "#/components/schemas/DefaultScheduleView", + "MONTHLY" : "#/components/schemas/MonthlyScheduleView", + "WEEKLY" : "#/components/schemas/WeeklyScheduleView" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultScheduleView" + }, { + "$ref" : "#/components/schemas/DailyScheduleView" + }, { + "$ref" : "#/components/schemas/WeeklyScheduleView" + }, { + "$ref" : "#/components/schemas/MonthlyScheduleView" + } ], + "properties" : { + "type" : { + "type" : "string", + "description" : "Type of schedule.", + "enum" : [ "DEFAULT", "DAILY", "WEEKLY", "MONTHLY" ] + } + }, + "required" : [ "type" ], + "title" : "Online Archive Schedule" + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "OpsGenie" : { + "type" : "object", + "description" : "Details to integrate one Opsgenie account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Opsgenie account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "Two-letter code that indicates which regional URL MongoDB uses to access the Opsgenie API.", + "enum" : [ "US", "EU" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "apiKey" ], + "title" : "OPS_GENIE" + }, + "OpsGenieNotification" : { + "type" : "object", + "description" : "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "opsGenieApiKey" : { + "type" : "string", + "description" : "API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************a111" + }, + "opsGenieRegion" : { + "type" : "string", + "default" : "US", + "description" : "Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "OPS_GENIE" ] + } + }, + "required" : [ "typeName" ], + "title" : "OpsGenie Notification" + }, + "OrgEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "ORG_CREATED", "SECURITY_CONTACT_MODIFIED", "ORG_CREDIT_CARD_ADDED", "ORG_CREDIT_CARD_UPDATED", "ORG_CREDIT_CARD_CURRENT", "ORG_CREDIT_CARD_ABOUT_TO_EXPIRE", "ORG_PAYPAL_LINKED", "ORG_PAYPAL_UPDATED", "ORG_PAYPAL_CANCELLED", "ORG_OVERRIDE_PAYMENT_METHOD_ADDED", "ORG_ACTIVATED", "ORG_TEMPORARILY_ACTIVATED", "ORG_SUSPENSION_DATE_CHANGED", "ORG_SUSPENDED", "ORG_ADMIN_SUSPENDED", "ORG_ADMIN_LOCKED", "ORG_CLUSTERS_DELETED", "ORG_CLUSTERS_PAUSED", "ORG_LOCKED", "ORG_UNDER_FINANCIAL_PROTECTION", "ORG_NO_FINANCIAL_PROTECTION", "ORG_RENAMED", "ALL_ORG_USERS_HAVE_MFA", "ORG_USERS_WITHOUT_MFA", "ORG_INVOICE_UNDER_THRESHOLD", "ORG_INVOICE_OVER_THRESHOLD", "ORG_DAILY_BILL_UNDER_THRESHOLD", "ORG_DAILY_BILL_OVER_THRESHOLD", "ORG_GROUP_CHARGES_UNDER_THRESHOLD", "ORG_GROUP_CHARGES_OVER_THRESHOLD", "ORG_TWO_FACTOR_AUTH_REQUIRED", "ORG_TWO_FACTOR_AUTH_OPTIONAL", "ORG_PUBLIC_API_ACCESS_LIST_REQUIRED", "ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED", "ORG_EMPLOYEE_ACCESS_RESTRICTED", "ORG_EMPLOYEE_ACCESS_UNRESTRICTED", "ORG_SFDC_ACCOUNT_ID_CHANGED", "ORG_CONNECTED_TO_MLAB", "ORG_DISCONNECTED_FROM_MLAB", "ORG_IDP_CERTIFICATE_CURRENT", "ORG_IDP_CERTIFICATE_ABOUT_TO_EXPIRE", "ORG_CONNECTED_TO_VERCEL", "ORG_DISCONNECTED_TO_VERCEL", "ORG_CONNECTION_UNINSTALLED_FROM_VERCEL", "ORG_UI_IP_ACCESS_LIST_ENABLED", "ORG_UI_IP_ACCESS_LIST_DISABLED", "ORG_EDITED_UI_IP_ACCESS_LIST_ENTRIES", "ORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITED" ], + "example" : "ORG_CREATED", + "title" : "Org Event Types" + }, + "OrgEventViewForOrg" : { + "type" : "object", + "description" : "Org event identifies different activities and changes in an organization settings.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "invoiceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies of the invoice associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Org Events" + }, + "OrgFederationSettings" : { + "type" : "object", + "description" : "Details that define how to connect one MongoDB Cloud organization to one federated authentication service.", + "properties" : { + "federatedDomains" : { + "type" : "array", + "description" : "List of domains associated with the organization's identity provider.", + "items" : { + "type" : "string" + }, + "uniqueItems" : true + }, + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "identityProviderId" : { + "type" : "string", + "description" : "Legacy 20-hexadecimal digit string that identifies the identity provider connected to this organization.", + "example" : "c2777a9eca931f29fc2f", + "maxLength" : 20, + "minLength" : 20, + "pattern" : "^([a-f0-9]{20})$" + }, + "identityProviderStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + }, + "title" : "Organization Federation Settings" + }, + "OrgGroup" : { + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "Settings that describe the clusters in each project that the API key is authorized to view.", + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + }, + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "planType" : { + "type" : "string", + "description" : "Human-readable label that indicates the plan type.", + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List of human-readable labels that categorize the specified project. MongoDB Cloud returns an empty array.", + "items" : { + "type" : "string", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "OrgNotification" : { + "type" : "object", + "description" : "Org notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "type" : "array", + "description" : "List that contains the one or more [organization](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "ORG" ] + } + }, + "required" : [ "typeName" ], + "title" : "Org Notification" + }, + "OrgPaginatedEventView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Service account creation time." + }, + "description" : { + "type" : "string", + "description" : "Description of the service account." + }, + "id" : { + "type" : "string", + "description" : "ID for the service account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, + "name" : { + "type" : "string", + "description" : "Name for service account." + }, + "roles" : { + "type" : "array", + "description" : "Organization roles assigned to the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + }, + "uniqueItems" : true + }, + "secrets" : { + "type" : "array", + "description" : "List of secrets.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "uniqueItems" : true + } + } + }, + "OrgServiceAccountRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Secret expiration time." + } + }, + "required" : [ "description", "name", "secretExpiresAfterHours" ] + }, + "OrgServiceAccountUpdateRequest" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Human readable description for the service account.", + "maxLength" : 250, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "name" : { + "type" : "string", + "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" + }, + "roles" : { + "type" : "array", + "description" : "Organization roles associated with the Service account.", + "items" : { + "type" : "string", + "description" : "Organization roles associated with the service account.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "OrganizationInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + }, + "uniqueItems" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies this organization.", + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the organization." + } + }, + "required" : [ "orgName" ] + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "OrganizationInvitationRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that belongs to the desired MongoDB Cloud user." + } + } + }, + "OrganizationInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of projects that the user will be added to when they accept their invitation to the organization.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamIds" : { + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true + } + } + }, + "OrganizationSettings" : { + "type" : "object", + "description" : "Collection of settings that configures the organization.", + "properties" : { + "apiAccessListRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require API operations to originate from an IP Address added to the API access list for the specified organization." + }, + "multiFactorAuthRequired" : { + "type" : "boolean", + "description" : "Flag that indicates whether to require users to set up Multi-Factor Authentication (MFA) before accessing the specified organization. To learn more, see: https://www.mongodb.com/docs/atlas/security-multi-factor-authentication/." + }, + "restrictEmployeeAccess" : { + "type" : "boolean", + "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure for any deployment in the specified organization without explicit permission. Once this setting is turned on, you can grant MongoDB Support a 24-hour bypass access to the Atlas deployment to resolve support issues. To learn more, see: https://www.mongodb.com/docs/atlas/security-restrict-support-access/." + } + } + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "type" : "object", + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + }, + "readOnly" : true + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Outbound Control Plane IP Addresses By Cloud Provider" + }, + "PagerDuty" : { + "type" : "object", + "description" : "Details to integrate one PagerDuty account with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "region" : { + "type" : "string", + "description" : "PagerDuty region that indicates the API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "Service key associated with your PagerDuty account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "serviceKey" ], + "title" : "PAGER_DUTY" + }, + "PagerDutyNotification" : { + "type" : "object", + "description" : "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "region" : { + "type" : "string", + "default" : "US", + "description" : "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", + "enum" : [ "US", "EU" ] + }, + "serviceKey" : { + "type" : "string", + "description" : "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "****************************7890" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "PAGER_DUTY" ] + } + }, + "required" : [ "typeName" ], + "title" : "PagerDuty Notification" + }, + "PaginatedAdvancedClusterDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertConfigView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAlertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiApiUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDatabaseUserView" : { + "type" : "object", + "description" : "List of MongoDB Database users granted access to databases in the specified project.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasDiskBackupExportJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasProviderRegionsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderRegions" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceMetadataView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoiceMetadata" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiInvoiceView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsConnectionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedApiUserAccessListResponseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAppUserView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAtlasGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/Group" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedAvailableVersionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MdbAvailableVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedBackupSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupReplicaSetView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudBackupShardedClusterSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedCloudProviderContainerView" : { + "type" : "object", + "description" : "List of Network Peering Containers that Amazon Web Services serves.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + }, + "title" : "Network Peering" + }, + "PaginatedClusterDescription20240805" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedConnectedOrgConfigsView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedContainerPeerView" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDatabaseView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedDiskPartitionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/EventTypeDetails" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedFederationIdentityProvider" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedGroupServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedHostView_Atlas" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link_Atlas" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedIntegrationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedLegacyClusterView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedNetworkAccessView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOnlineArchiveView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgGroupView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrgServiceAccounts" : { + "type" : "object", + "description" : "List of Service Accounts", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedOrganizationView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPipelineRunView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedPrivateNetworkEndpointIdEntryView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRestoreJobView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedRoleMappingView" : { + "type" : "object", + "description" : "List role mappings from the specified organization in the specified federation.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServerlessInstanceDescriptionView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedServiceAccountGroup" : { + "type" : "object", + "description" : "List of Service Account projects.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountGroup" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamRoleView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTeamView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantRestoreView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedTenantSnapshotView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUSSInstance20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PaginatedUserCertView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "items" : { + "$ref" : "#/components/schemas/UserCert" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, + "PartialFilter" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "description" : "Rules that limit the documents that the index references to a filter expression. All MongoDB index types accept a **partialFilterExpression** option. **partialFilterExpression** can include following expressions:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n This option applies to all index types." + }, + "PartitionFieldView" : { + "type" : "object", + "description" : "Metadata to partition this online archive.", + "properties" : { + "fieldName" : { + "type" : "string", + "description" : "Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.", + "maxLength" : 700 + }, + "fieldType" : { + "type" : "string", + "description" : "Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type [UUID](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "enum" : [ "date", "int", "long", "objectId", "string", "uuid" ], + "readOnly" : true + }, + "order" : { + "type" : "integer", + "format" : "int32", + "default" : 0, + "description" : "Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the **criteria.dateField** parameter defaults as the first item in the partition sequence." + } + }, + "required" : [ "fieldName", "order" ], + "title" : "Online Archive Partition" + }, + "PemFileInfo" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509Certificate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "description" : "PEM file information for the identity provider's current certificates.", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + } + }, + "PerformanceAdvisorIndex" : { + "type" : "object", + "properties" : { + "avgObjSize" : { + "type" : "number", + "format" : "double", + "description" : "The average size of an object in the collection of this index.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "impact" : { + "type" : "array", + "description" : "List that contains unique 24-hexadecimal character string that identifies the query shapes in this response that the Performance Advisor suggests.", + "items" : { + "type" : "string", + "description" : "One unique 24-hexadecimal character string that identifies one query shape.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true + }, + "index" : { + "type" : "array", + "description" : "List that contains documents that specify a key in the index and its sort order.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32", + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index.", + "enum" : [ 1, -1 ] + }, + "description" : "One index key paired with its sort order. A value of `1` indicates an ascending sort order. A value of `-1` indicates a descending sort order. Keys in indexes with multiple keys appear in the same order that they appear in the index." + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "weight" : { + "type" : "number", + "format" : "double", + "description" : "Estimated performance improvement that the suggested index provides. This value corresponds to **Impact** in the Performance Advisor user interface.", + "readOnly" : true + } + } + }, + "PerformanceAdvisorOpStats" : { + "type" : "object", + "description" : "Details that this resource returned about the specified query.", + "properties" : { + "ms" : { + "type" : "integer", + "format" : "int64", + "description" : "Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds. This parameter relates to the **duration** query parameter.", + "readOnly" : true + }, + "nReturned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of results that the query returns.", + "readOnly" : true + }, + "nScanned" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of documents that the query read.", + "readOnly" : true + }, + "ts" : { + "type" : "integer", + "format" : "int64", + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorOperationView" : { + "type" : "object", + "properties" : { + "predicates" : { + "type" : "array", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "items" : { + "type" : "object", + "description" : "List that contains the search criteria that the query uses. To use the values in key-value pairs in these predicates requires **Project Data Access Read Only** permissions or greater. Otherwise, MongoDB Cloud redacts these values.", + "readOnly" : true + }, + "readOnly" : true + }, + "stats" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOpStats" + } + } + }, + "PerformanceAdvisorResponse" : { + "type" : "object", + "properties" : { + "shapes" : { + "type" : "array", + "description" : "List of query predicates, sorts, and projections that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorShape" + }, + "readOnly" : true + }, + "suggestedIndexes" : { + "type" : "array", + "description" : "List that contains the documents with information about the indexes that the Performance Advisor suggests.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorIndex" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorShape" : { + "type" : "object", + "properties" : { + "avgMs" : { + "type" : "integer", + "format" : "int64", + "description" : "Average duration in milliseconds for the queries examined that match this shape.", + "readOnly" : true + }, + "count" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of queries examined that match this shape.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this shape. This string exists only for the duration of this API request.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inefficiencyScore" : { + "type" : "integer", + "format" : "int64", + "description" : "Average number of documents read for every document that the query returns.", + "externalDocs" : { + "description" : "Understanding the Query Inefficiency Score", + "url" : "https://www.mongodb.com/docs/atlas/performance-advisor/#std-label-query-inefficiency-score" + }, + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + }, + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" + }, + "readOnly" : true + } + } + }, + "PerformanceAdvisorSlowQuery" : { + "type" : "object", + "description" : "Details of one slow query that the Performance Advisor detected.", + "properties" : { + "line" : { + "type" : "string", + "description" : "Text of the MongoDB log related to this slow query.", + "readOnly" : true + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PerformanceAdvisorSlowQueryList" : { + "type" : "object", + "properties" : { + "slowQueries" : { + "type" : "array", + "description" : "List of operations that the Performance Advisor detected that took longer to execute than a specified threshold.", + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + }, + "readOnly" : true + } + } + }, + "PeriodicCpsSnapshotSource" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/IngestionSource" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable name that identifies the cluster." + }, + "collectionName" : { + "type" : "string", + "description" : "Human-readable name that identifies the collection." + }, + "databaseName" : { + "type" : "string", + "description" : "Human-readable name that identifies the database." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policyItemId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + } ], + "description" : "Scheduled Cloud Provider Snapshot as Source for a Data Lake Pipeline.", + "title" : "Periodic Cloud Provider Snapshot Source" + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "description" : "Pinned namespaces view for cluster", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + }, + "readOnly" : true + } + } + }, + "PipelineRunStats" : { + "type" : "object", + "description" : "Runtime statistics for this Data Lake Pipeline run.", + "properties" : { + "bytesExported" : { + "type" : "integer", + "format" : "int64", + "description" : "Total data size in bytes exported for this pipeline run.", + "readOnly" : true + }, + "numDocs" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of docs ingested for a this pipeline run.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Data Lake Pipeline Run Statistics" + }, + "PrivateEndpointHostname" : { + "type" : "object", + "description" : "Set of Private endpoint and hostnames.", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Human-readable label that identifies the hostname.", + "readOnly" : true + }, + "privateEndpoint" : { + "type" : "string", + "description" : "Human-readable label that identifies private endpoint.", + "readOnly" : true + } + }, + "readOnly" : true + }, + "PrivateGCPEndpointGroup" : { + "type" : "object", + "description" : "Group of Private Endpoint settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "endpointGroupName" : { + "type" : "string", + "description" : "Human-readable label that identifies a set of endpoints.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "endpoints" : { + "type" : "array", + "description" : "List of individual private endpoints that comprise this endpoint group.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "items" : { + "$ref" : "#/components/schemas/GCPConsumerForwardingRule" + }, + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the Google Cloud network endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "VERIFIED", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "PrivateIPModeView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled **Connect via Peering Only** mode for the specified project." + } + }, + "required" : [ "enabled" ] + }, + "PrivateLinkEndpoint" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/AWSInterfaceEndpoint", + "AZURE" : "#/components/schemas/AzurePrivateEndpoint", + "GCP" : "#/components/schemas/PrivateGCPEndpointGroup" + }, + "propertyName" : "cloudProvider" + }, + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "deleteRequested" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud received a request to remove the specified private endpoint from the private endpoint service.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ] + }, + "PrivateNetworkEndpointIdEntry" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable string to associate with this private endpoint." + }, + "customerEndpointDNSName" : { + "type" : "string", + "description" : "Human-readable label to identify customer's VPC endpoint DNS name." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "externalDocs" : { + "description" : "Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.", + "url" : "https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc" + }, + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + }, + "provider" : { + "type" : "string", + "default" : "AWS", + "description" : "Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.", + "enum" : [ "AWS" ] + }, + "region" : { + "type" : "string", + "description" : "Human-readable label to identify the region of customer's VPC endpoint." + }, + "type" : { + "type" : "string", + "default" : "DATA_LAKE", + "description" : "Human-readable label that identifies the resource type associated with this private endpoint.", + "enum" : [ "DATA_LAKE" ] + } + }, + "required" : [ "endpointId" ] + }, + "ProjectSettingItemView" : { + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.\n\n- Set this value to `true` to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- Set this value to `false` to disable regionalized private endpoints." + } + }, + "required" : [ "enabled" ] + }, + "Prometheus" : { + "type" : "object", + "description" : "Details to integrate one Prometheus account with one MongoDB Cloud project.", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone has activated the Prometheus integration." + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "password" : { + "type" : "string", + "description" : "Password needed to allow MongoDB Cloud to access your Prometheus account.", + "writeOnly" : true + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "enum" : [ "http", "file" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "PROMETHEUS" ] + }, + "username" : { + "type" : "string", + "description" : "Human-readable label that identifies your Prometheus incoming webhook.", + "example" : "prom_user_618d48e05277a606ed2496fe" + } + }, + "required" : [ "enabled", "serviceDiscovery", "username" ], + "title" : "PROMETHEUS" + }, + "ProxyInfo" : { + "type" : "object", + "description" : "VPC Proxy Information.", + "properties" : { + "authKey" : { + "type" : "string", + "description" : "Authentication key for the proxy." + }, + "dnsName" : { + "type" : "string", + "description" : "DNS name to use to reach the proxy/s." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this feature was enabled on.", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ], + "readOnly" : true + } + } + }, + "RPUMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/ServerlessMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "RawMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "RawMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "RawMetricUnits" : { + "type" : "string", + "default" : "RAW", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RAW" ], + "title" : "Raw Metric Units" + }, + "RawMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "readOnly" : true, + "title" : "Raw Metric Value" + }, + "RegionSpec" : { + "type" : "object", + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "properties" : { + "analyticsNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use **replicationSpecs[n].{region}.analyticsNodes** instead." + }, + "electableNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use **replicationSpecs[n].{region}.electableNodes** instead.", + "enum" : [ 0, 3, 5, 7 ] + }, + "priority" : { + "type" : "integer", + "format" : "int32", + "description" : "Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to `7`. The primary node runs in the **Preferred Region**. To identify a read-only region, set this parameter to `0`.", + "maximum" : 7, + "minimum" : 0 + }, + "readOnlyNodes" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use **replicationSpecs[n].{region}.readOnlyNodes** instead." + } + }, + "title" : "Region Configuration" + }, + "ReplicaSetAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Alert Configuration" + }, + "ReplicaSetAlertViewForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet alert notifies about different activities on replica set of mongod instances.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "nonRunningHostIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal character strings that identify the replica set members that are not in PRIMARY nor SECONDARY state.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "readOnly" : true + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "parentClusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the parent cluster to which this alert applies. The parent cluster contains the sharded nodes. MongoDB Cloud returns this parameter only for alerts of events impacting sharded clusters.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "ReplicaSet Alerts" + }, + "ReplicaSetEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "PRIMARY_ELECTED", "REPLICATION_OPLOG_WINDOW_HEALTHY", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "ONE_PRIMARY", "NO_PRIMARY", "TOO_MANY_ELECTIONS" ], + "example" : "PRIMARY_ELECTED", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertable" : { + "type" : "string", + "description" : "Incident that triggered this alert.", + "enum" : [ "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "NO_PRIMARY", "PRIMARY_ELECTED", "TOO_MANY_ELECTIONS" ], + "example" : "NO_PRIMARY", + "readOnly" : true, + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "NO_PRIMARY", "PRIMARY_ELECTED" ], + "example" : "NO_PRIMARY", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" ], + "example" : "TOO_MANY_ELECTIONS", + "title" : "ReplicaSet Event Types" + }, + "ReplicaSetMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing an replica set against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/ReplicaSetMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "ReplicaSetMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], + "example" : "REPLICA_SET_NAME", + "title" : "Replica Set Matcher Fields" + }, + "ReplicaSetThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", + "discriminator" : { + "mapping" : { + "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" : "#/components/schemas/LessThanTimeThresholdAlertConfigViewForNdsGroup", + "TOO_MANY_ELECTIONS" : "#/components/schemas/GreaterThanRawThresholdAlertConfigViewForNdsGroup" + }, + "propertyName" : "eventTypeName" + }, + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/AlertsThresholdInteger" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Replica Set Threshold Alert Configuration" + }, + "ReplicationSpec" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Multi-Cloud Cluster. If you include existing zones in the request, you must specify this parameter. If you add a new zone to an existing Multi-Cloud Cluster, you may specify this parameter. The request deletes any existing zones in the Multi-Cloud Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "description" : "Positive integer that specifies the number of shards to deploy in each specified zone. If you set this value to `1` and **clusterType** is `SHARDED`, MongoDB Cloud deploys a single-shard sharded cluster. Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "minimum" : 1 + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**. Every hardware specification must use the same **instanceSize**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." + } + }, + "title" : "Replication Specifications" + }, + "ReplicationSpec20240805" : { + "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } + }, + "zoneId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "title" : "Replication Specifications" + }, + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceEventViewForOrg" : { + "type" : "object", + "description" : "Resource event reflects different activities about resources.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" + }, + "ResourceTag" : { + "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", + "properties" : { + "key" : { + "type" : "string", + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + }, + "value" : { + "type" : "string", + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashed file.", + "readOnly" : true + }, + "hash" : { + "type" : "string", + "description" : "Hashed checksum that maps to the restore file.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which this role belongs. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "role" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SMS" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "completeDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Details of the error returned when MongoDB Cloud loads the sample dataset. This endpoint returns null if state has a value other than FAILED.", + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "Status of the sample dataset load job.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + } + }, + "SearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Host Status Detail" + }, + "SearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see documentation.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" + }, + "SearchIndexResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" + }, + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." + }, + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." + }, + "indexID" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } + }, + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "title" : "Search Index Response" + }, + "SearchIndexUpdateRequest" : { + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + }, + "required" : [ "definition" ], + "title" : "Search Index Update Request" + }, + "SearchMainIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about the active index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Main Index Status Detail" + }, + "SearchMappings" : { + "type" : "object", + "description" : "Index specifications for the collection's fields.", + "properties" : { + "dynamic" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index uses dynamic or static mappings. Required if **mappings.fields** is omitted.", + "externalDocs" : { + "description" : "Dynamic or Static Mappings", + "url" : "https://dochub.mongodb.org/core/field-mapping-definition-fts#static-and-dynamic-mappings" + } + }, + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "title" : "Mappings" + }, + "SearchStagedIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about an index building in the background.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "name" : { + "type" : "string", + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + }, + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AWS" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "AWS" + }, + "ServerlessAWSTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" + }, + "ServerlessAzureTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless Azure tenant endpoint.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "privateLinkServiceResourceId" : { + "type" : "string", + "description" : "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "title" : "Azure" + }, + "ServerlessAzureTenantEndpointUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } + } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" + }, + "ServerlessBackupRestoreJob" : { + "type" : "object", + "properties" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "enum" : [ "automated", "download", "pointInTime" ] + }, + "deliveryUrl" : { + "type" : "array", + "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + }, + "readOnly" : true + }, + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true + }, + "finishedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "description" : "Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds** exceeds `0`.", + "minimum" : 1199145600 + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "targetClusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `\"deliveryType\":` `\"automated\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "targetGroupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "timestamp" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot associated with **snapshotId**. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + }, + "ServerlessBackupSnapshot" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongodVersion" : { + "type" : "string", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "serverlessInstanceName" : { + "type" : "string", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "snapshotType" : { + "type" : "string", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], + "readOnly" : true + }, + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", + "readOnly" : true + } + } + }, + "ServerlessConnectionStringsPrivateEndpointItem" : { + "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", + "properties" : { + "endpointId" : { + "type" : "string", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], + "readOnly" : true + }, + "region" : { + "type" : "string", + "description" : "Region where the private endpoint is deployed.", + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, + "readOnly" : true + }, + "srvConnectionString" : { + "type" : "string", + "description" : "Private endpoint-aware connection string that uses the `mongodb+srv://` protocol to connect to MongoDB Cloud through a private endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS).", + "readOnly" : true + }, + "type" : { + "type" : "string", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], + "readOnly" : true + } + }, + "title" : "Serverless Instance Private Endpoint Connection String" + }, + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" + }, + "ServerlessInstanceDescription" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB serverless instance.", + "properties" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" + }, + "ServerlessInstanceDescriptionConnectionStrings" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "privateEndpoint" : { + "type" : "array", + "description" : "List of private endpoint-aware connection strings that you can use to connect to this serverless instance through a private endpoint. This parameter returns only if you created a private endpoint for this serverless instance and it is AVAILABLE.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" + }, + "ServerlessInstanceDescriptionCreate" : { + "type" : "object", + "description" : "Settings that you can specify when you create a serverless instance.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" + }, + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" + }, + "ServerlessInstanceDescriptionUpdate" : { + "type" : "object", + "description" : "Settings that you can update when you request a serverless cluster update.", + "properties" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + } + }, + "title" : "Serverless Instance Description Update" + }, + "ServerlessMetricAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "Matching conditions for target resources.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Serverless Alert Configuration" + }, + "ServerlessMetricThreshold" : { + "type" : "object", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "providerName" : { + "type" : "string", + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "readOnly" : true + }, + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true + }, + "endpointServiceName" : { + "type" : "string", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "readOnly" : true + }, + "errorMessage" : { + "type" : "string", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { + "type" : "string", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "ServiceAccountEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountOrgEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" + }, + "ServiceAccountSecret" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing creation time.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing secret expiration time.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Timestamp representing last secret usage.", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "Service Account secret with masked values of the first 20 characters.", + "example" : "mdb_ic_sk_xxxxxxxx-xxxx-xxxx-xxxxxxxx12ce", + "readOnly" : true + }, + "secret" : { + "type" : "string", + "description" : "Secret for the service account. It will be returned only the first time after service account creation.", + "pattern" : "^mdb_sa_sk_[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "readOnly" : true + } + }, + "required" : [ "createdAt", "expiresAt", "id" ] + }, + "ServiceAccountSecretRequest" : { + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of hours representing validity duration for secret." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "database" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", + "writeOnly" : true + }, + "shardCollection" : { + "$ref" : "#/components/schemas/ShardKeys" + } + }, + "required" : [ "collection", "database", "shardCollection" ] + }, + "ShardKeys" : { + "type" : "object", + "description" : "Document that configures the shard key on the destination cluster.", + "properties" : { + "key" : { + "type" : "array", + "description" : "List of fields to use for the shard key.", + "items" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "writeOnly" : true + }, + "ShardingRequest" : { + "type" : "object", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", + "properties" : { + "createSupportingIndexes" : { + "type" : "boolean", + "description" : "Flag that lets the migration create supporting indexes for the shard keys, if none exists, as the destination cluster also needs compatible indexes for the specified shard keys.", + "writeOnly" : true + }, + "shardingEntries" : { + "type" : "array", + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "items" : { + "$ref" : "#/components/schemas/ShardEntry" + }, + "uniqueItems" : true, + "writeOnly" : true + } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true + }, + "Slack" : { + "type" : "object", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Slack account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.\n\n**IMPORTANT**: Slack integrations now use the OAuth2 verification method and must be initially configured, or updated from a legacy integration, through the Atlas third-party service integrations page. Legacy tokens will soon no longer be supported.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "teamName" : { + "type" : "string", + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" + }, + "SlackNotification" : { + "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "apiToken" : { + "type" : "string", + "description" : "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "**********************************************************************abcd" + }, + "channelName" : { + "type" : "string", + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", + "example" : "alerts" + }, + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SLACK" ] + } + }, + "required" : [ "typeName" ], + "title" : "Slack Notification" + }, + "Source" : { + "type" : "object", + "description" : "Document that describes the source of the migration.", + "properties" : { + "caCertificatePath" : { + "type" : "string", + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + }, + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." + }, + "password" : { + "type" : "string", + "description" : "Password that authenticates the username to the source cluster.", + "writeOnly" : true + }, + "ssl" : { + "type" : "boolean", + "description" : "Flag that indicates whether you have SSL enabled." + }, + "username" : { + "type" : "string", + "description" : "Label that identifies the SCRAM-SHA user that connects to the source cluster.", + "writeOnly" : true + } + }, + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] + }, + "StorageEngine" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "description" : "Storage engine set for the specific index. This value can be set only at creation. This option uses the following format: `\"storageEngine\" : { \"\" : \"\" }` MongoDB validates storage engine configuration options when creating indexes. To support replica sets with members with different storage engines, MongoDB logs these options to the oplog during replication. This option applies to all index types.", + "externalDocs" : { + "description" : "MongoDB Server Storage Engines", + "url" : "https://docs.mongodb.com/manual/core/storage-engines/" + } + }, + "StreamConfig" : { + "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "tier" : { + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" + } + } + }, + "StreamProcessorAlertConfigViewForNdsGroup" : { + "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" + }, + "StreamProcessorAlertViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "The name of the Stream Processing Instance to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processing Instances.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "The name of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" + }, + "StreamProcessorEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" + }, + "StreamProcessorEventViewForNdsGroup" : { + "type" : "object", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "processorErrorMsg" : { + "type" : "string", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection that will be used for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database that will be used for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Streams Events" + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + }, + "password" : { + "type" : "string", + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true + }, + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + } + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "proxyInfo" : { + "$ref" : "#/components/schemas/ProxyInfo" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "description" : "Information about the networking access.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Id of the vpc peer when the type is VPC." + }, + "type" : { + "type" : "string", + "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", + "enum" : [ "PUBLIC", "VPC" ], + "title" : "Networking Access Type" + } + } + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + } + }, + "StreamsMatcher" : { + "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", + "properties" : { + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" + }, + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" + } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" + }, + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" + }, + "StreamsOptions" : { + "type" : "object", + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." + }, + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + } + } + } + }, + "StreamsProcessorWithStats" : { + "type" : "object", + "description" : "An atlas stream processor with optional stats.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true + } + }, + "required" : [ "_id", "name", "pipeline", "state" ] + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true + }, + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" + } + } + }, + "SummaryNotification" : { + "type" : "object", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailAddress" : { + "type" : "string", + "format" : "email", + "description" : "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "SUMMARY" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + }, + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + } + }, + "title" : "Synonym Mapping Status Detail" + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", + "properties" : { + "collection" : { + "type" : "string", + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "required" : [ "collection" ] + }, + "SystemStatus" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" + }, + "appName" : { + "type" : "string", + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true + }, + "build" : { + "type" : "string", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { + "type" : "string", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" + }, + "TeamNotification" : { + "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "teamName" : { + "type" : "string", + "description" : "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", + "example" : "Atlas" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] + } + }, + "required" : [ "typeName" ], + "title" : "Team Notification" + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." + } + } + }, + "TeamRole" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } + }, + "TeamUpdate" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true + } + }, + "required" : [ "name" ] + }, + "TenantHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" + } + } + }, + "TenantRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" + }, + "TenantRestore" : { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier *M2* or greater.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TextSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "analyzers" : { + "type" : "array", + "description" : "List of user-defined methods to convert database field text into searchable words.", + "externalDocs" : { + "description" : "Custom Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/custom-fts" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "storedSource" : { + "type" : "object", + "description" : "Flag that indicates whether to store all fields (true) on Atlas Search. By default, Atlas doesn't store (false) the fields on Atlas Search. Alternatively, you can specify an object that only contains the list of fields to store (include) or not store (exclude) on Atlas Search. To learn more, see Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { + "type" : "array", + "description" : "Rule sets that map words to their synonyms in this index.", + "externalDocs" : { + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } + } + }, + "title" : "Text Search Index Status Detail" + }, + "ThirdPartyIntegration" : { + "type" : "object", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" + } + }, + "title" : "Third-Party Integration" + }, + "TimeMetricAlertView" : { + "type" : "object", + "properties" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "hostnameAndPort" : { + "type" : "string", + "description" : "Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.", + "example" : "cloud-test.mongodb.com:27017", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that this alert changed to `\"status\" : \"CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once `\"status\" : \"CLOSED\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + }, + "TimeMetricEventView" : { + "type" : "object", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "metricName" : { + "type" : "string", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ] + }, + "TimeMetricThresholdView" : { + "type" : "object", + "properties" : { + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + }, + "mode" : { + "type" : "string", + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] + }, + "operator" : { + "$ref" : "#/components/schemas/Operator" + }, + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" + }, + "TimeMetricValueView" : { + "type" : "object", + "description" : "Measurement of the **metricName** recorded at the time of the event.", + "properties" : { + "number" : { + "type" : "number", + "format" : "double", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", + "readOnly" : true + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] + } + }, + "required" : [ "type" ], + "title" : "flattenGraph" + }, + "TokenFilterPorterStemming" : { + "type" : "object", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } + }, + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + } + }, + "required" : [ "snapshotId" ] + }, + "USSBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a USS instance.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + }, + "targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "title" : "USS Backup Restore Job" + }, + "USSBackupRestoreJobCreate20250101" : { + "type" : "object", + "description" : "Details to create one restore job of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true + }, + "_targetProjectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "projectId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to `CLOSED`. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotUrl" : { + "type" : "string", + "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create USS Backup Restore Job" + }, + "USSBackupSettings20250101" : { + "type" : "object", + "description" : "USS backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS backup configuration" + }, + "USSBackupSnapshot20250101" : { + "type" : "object", + "description" : "Details for one snapshot of a USS instance.", + "properties" : { + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "scheduledTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true + } + }, + "title" : "USS Backup Snapshot" + }, + "USSBackupSnapshotDownloadCreate20250101" : { + "type" : "object", + "description" : "Details for one backup snapshot download of a USS instance.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "required" : [ "_snapshotId" ], + "title" : "USS Backup Snapshot Download Create" + }, + "USSConnectionStrings20250101" : { + "type" : "object", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "USS Instance Connection Strings" + }, + "USSInstanceDescription20250101" : { + "type" : "object", + "description" : "Group of settings that configure a MongoDB USS instance.", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/USSBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "USS instance topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/USSConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], + "readOnly" : true + } + }, + "required" : [ "providerSettings" ], + "title" : "USS Instance Description" + }, + "USSInstanceDescriptionCreate20250101" : { + "type" : "object", + "description" : "Settings that you can specify when you create a USS instance.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + } + }, + "required" : [ "name", "providerSettings" ], + "title" : "USS Instance Description Create" + }, + "USSProviderSettings20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a USS Instance" + }, + "USSProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "USS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "USS" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB USS instance. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a USS Instance", + "writeOnly" : true + }, + "UpdateAtlasOrganizationApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this organization API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "UpdateAtlasProjectApiKey" : { + "type" : "object", + "properties" : { + "desc" : { + "type" : "string", + "description" : "Purpose or explanation provided when someone creates this project API key.", + "maxLength" : 250, + "minLength" : 1 + }, + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "UpdateCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + } + } + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + }, + "uniqueItems" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UpdateOrgRolesForUser" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, + "UserAccessListRequest" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress** but not both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock** but not both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + } + } + }, + "UserAccessListResponse" : { + "type" : "object", + "properties" : { + "cidrBlock" : { + "type" : "string", + "description" : "Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation in the access list for the API key.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))((%2[fF]|\\/)[0-9]{1,3})+$" + }, + "count" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of requests that have originated from the Internet Protocol (IP) address given as the value of the *lastUsedAddress* parameter.", + "minimum" : 1, + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone added the network addresses to the specified API access list. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "Network address in the access list for the API key.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$" + }, + "lastUsed" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request has originated from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastUsedAddress" : { + "type" : "string", + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address made at least one request.", + "example" : "203.0.113.10", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|([\\:]{0,2}([0-9a-f]{1,4}\\:){0,7}[0-9a-f]{1,4}[\\:]{0,2}))$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserAccessRoleAssignment" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "UserCert" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "integer", + "format" : "int64", + "description" : "Unique 24-hexadecimal character string that identifies this certificate.", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this certificate. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "monthsUntilExpiration" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "description" : "Number of months that the certificate remains valid until it expires.", + "maximum" : 24, + "writeOnly" : true + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this certificate expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "subject" : { + "type" : "string", + "description" : "Subject Alternative Name associated with this certificate. This parameter expresses its value as a distinguished name as defined in [RFC 2253](https://tools.ietf.org/html/2253).", + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com", + "pattern" : "^(?:(?CN=(?[^,]*)),)?(?:(?(?:(?:CN|OU)=[^,]+,?)+),)?(?(?:DC=[^,]+,?)+)$", + "readOnly" : true + } + } + }, + "UserCustomDBRole" : { + "type" : "object", + "properties" : { + "actions" : { + "type" : "array", + "description" : "List of the individual privilege actions that the role grants.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + }, + "uniqueItems" : true + }, + "roleName" : { + "type" : "string", + "description" : "Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project." + } + }, + "required" : [ "roleName" ] + }, + "UserEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "INVITED_TO_GROUP", "REQUESTED_TO_JOIN_GROUP", "GROUP_INVITATION_DELETED", "USER_ROLES_CHANGED_AUDIT", "JOIN_GROUP_REQUEST_DENIED_AUDIT", "JOIN_GROUP_REQUEST_APPROVED_AUDIT" ], + "example" : "JOINED_GROUP", + "title" : "User Event Types" + }, + "UserEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "JOINED_ORG", "JOINED_TEAM", "INVITED_TO_ORG", "ORG_INVITATION_DELETED", "REMOVED_FROM_ORG", "REMOVED_FROM_TEAM", "USER_ROLES_CHANGED_AUDIT", "ORG_FLEX_CONSULTING_PURCHASED", "ORG_FLEX_CONSULTING_PURCHASE_FAILED", "INVITED_TO_TEAM" ], + "example" : "JOINED_ORG", + "title" : "User Event Types" + }, + "UserEventViewForNdsGroup" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserEventViewForOrg" : { + "type" : "object", + "description" : "User event reflects different activities about the atlas user.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "targetUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the console user that this event targets. The resource returns this parameter when `\"eventTypeName\" : \"USER\"`.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "User Events" + }, + "UserNotification" : { + "type" : "object", + "description" : "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "emailEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "smsEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "USER" ] + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`." + } + }, + "required" : [ "typeName" ], + "title" : "User Notification" + }, + "UserScope" : { + "type" : "object", + "description" : "Range of resources available to this database user.", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + }, + "type" : { + "type" : "string", + "description" : "Category of resource that this database user can access.", + "enum" : [ "CLUSTER", "DATA_LAKE", "STREAM" ] + } + }, + "required" : [ "name", "type" ], + "title" : "Database User Scope" + }, + "UserSecurity" : { + "type" : "object", + "properties" : { + "customerX509" : { + "$ref" : "#/components/schemas/DBUserTLSX509Settings" + }, + "ldap" : { + "$ref" : "#/components/schemas/LDAPSecuritySettings" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + } + }, + "UserToDNMapping" : { + "type" : "object", + "description" : "User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.", + "properties" : { + "ldapQuery" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) query template that inserts the LDAP name that the regular expression matches into an LDAP query Uniform Resource Identifier (URI). The formatting for the query must conform to [RFC 4515](https://datatracker.ietf.org/doc/html/rfc4515) and [RFC 4516](https://datatracker.ietf.org/doc/html/rfc4516)." + }, + "match" : { + "type" : "string", + "description" : "Regular expression that MongoDB Cloud uses to match against the provided Lightweight Directory Access Protocol (LDAP) username. Each parenthesis-enclosed section represents a regular expression capture group that the substitution or `ldapQuery` template uses.", + "example" : "(.*)" + }, + "substitution" : { + "type" : "string", + "description" : "Lightweight Directory Access Protocol (LDAP) Distinguished Name (DN) template that converts the LDAP username that matches regular expression in the *match* parameter into an LDAP Distinguished Name (DN).", + "example" : "CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com" + } + }, + "required" : [ "match" ], + "title" : "User to Distinguished Name Mapping" + }, + "VectorSearchHostStatusDetail" : { + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Host Status Detail" + }, + "VectorSearchIndex" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "VectorSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ], + "description" : "Vector Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "VectorSearchIndexDefinition" : { + "type" : "object", + "description" : "The vector search index definition set by the user.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Settings that configure the fields, one per object, to index. You must define at least one \"vector\" type field. You can optionally define \"filter\" type fields also.", + "externalDocs" : { + "description" : "Vector Search Fields", + "url" : "https://dochub.mongodb.org/core/avs-vector-type" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + }, + "title" : "Vector Search Index Definition" + }, + "VectorSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" + } + } + } + } ], + "title" : "Vector Search Index Response" + }, + "VectorSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a vector search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { + "type" : "string", + "description" : "Optional message describing an error." + }, + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Vector Search Index Status Detail" + }, + "VictorOps" : { + "type" : "object", + "description" : "Details to integrate one Splunk On-Call account with one MongoDB Cloud project.", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your VictorOps account.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "routingKey" : { + "type" : "string", + "description" : "Routing key associated with your Splunk On-Call account.", + "example" : "test routing" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "VICTOR_OPS" ] + } + }, + "required" : [ "apiKey" ], + "title" : "VICTOR_OPS" + }, + "VictorOpsNotification" : { + "type" : "object", + "description" : "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "VICTOR_OPS" ] + }, + "victorOpsApiKey" : { + "type" : "string", + "description" : "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", + "example" : "********************************9abc" + }, + "victorOpsRoutingKey" : { + "type" : "string", + "description" : "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", + "example" : "test routing" + } + }, + "required" : [ "typeName" ], + "title" : "VictorOps Notification" + }, + "Webhook" : { + "type" : "object", + "description" : "Details to integrate one webhook with one MongoDB Cloud project.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "secret" : { + "type" : "string", + "description" : "An optional field returned if your webhook is configured with a secret.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.", + "enum" : [ "WEBHOOK" ] + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "url" ], + "title" : "WEBHOOK" + }, + "WebhookNotification" : { + "type" : "object", + "description" : "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." + }, + "integrationId" : { + "type" : "string", + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "type" : "string", + "description" : "The notifierId is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "typeName" : { + "type" : "string", + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "WEBHOOK" ] + }, + "webhookSecret" : { + "type" : "string", + "description" : "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhookUrl either on the [Integrations](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/#std-label-third-party-integrations) page, or with the [Integrations API](#tag/Third-Party-Service-Integrations/operation/createIntegration)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "required" : [ "typeName" ], + "title" : "Webhook Notification" + }, + "WeeklyScheduleView" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OnlineArchiveSchedule" + }, { + "type" : "object", + "properties" : { + "dayOfWeek" : { + "type" : "integer", + "format" : "int32", + "description" : "Day of the week when the scheduled archive starts. The week starts with Monday (`1`) and ends with Sunday (`7`).", + "maximum" : 7, + "minimum" : 1 + }, + "endHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the scheduled window to run one online archive ends.", + "maximum" : 23, + "minimum" : 0 + }, + "endMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive ends.", + "maximum" : 59, + "minimum" : 0 + }, + "startHour" : { + "type" : "integer", + "format" : "int32", + "description" : "Hour of the day when the when the scheduled window to run one online archive starts.", + "maximum" : 23, + "minimum" : 0 + }, + "startMinute" : { + "type" : "integer", + "format" : "int32", + "description" : "Minute of the hour when the scheduled window to run one online archive starts.", + "maximum" : 59, + "minimum" : 0 + } + } + } ], + "required" : [ "type" ] + }, + "Weights" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "description" : "Relative importance to place upon provided index parameters. This object expresses this as key/value pairs of index parameter and weight to apply to that parameter. You can specify weights for some or all the indexed parameters. The weight must be an integer between 1 and 99,999. MongoDB 5.0 and later can apply **weights** to **text** indexes only." + }, + "X509Certificate" : { + "type" : "object", + "properties" : { + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "format" : "date-time", + "description" : "Latest date that the certificate is valid." + }, + "notBefore" : { + "type" : "string", + "format" : "date-time", + "description" : "Earliest date that the certificate is valid." + } + } + }, + "ZoneMapping" : { + "type" : "object", + "description" : "Human-readable label that identifies the subset of a global cluster.", + "properties" : { + "location" : { + "type" : "string", + "description" : "Code that represents a location that maps to a zone in your global cluster. MongoDB Cloud represents this location with a ISO 3166-2 location and subdivision codes when possible." + }, + "zone" : { + "type" : "string", + "description" : "Human-readable label that identifies the zone in your global cluster. This zone maps to a location code." + } + }, + "required" : [ "location", "zone" ], + "title" : "Global Cluster Zone" + }, + "charFilterhtmlStrip" : { + "type" : "object", + "description" : "Filter that strips out HTML constructs.", + "properties" : { + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "htmlStrip" ] + } + }, + "required" : [ "type" ], + "title" : "htmlStrip" + }, + "charFiltericuNormalize" : { + "type" : "object", + "description" : "Filter that processes normalized text with the ICU Normalizer. It is based on Lucene's ICUNormalizer2CharFilter.", + "externalDocs" : { + "description" : "ICUNormalizer2CharFilter", + "url" : "https://lucene.apache.org/core/8_3_0/analyzers-icu/org/apache/lucene/analysis/icu/ICUNormalizer2CharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "icuNormalize" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalize" + }, + "charFiltermapping" : { + "type" : "object", + "description" : "Filter that applies normalization mappings that you specify to characters.", + "properties" : { + "mappings" : { + "type" : "object", + "description" : "Comma-separated list of mappings. A mapping indicates that one character or group of characters should be substituted for another, using the following format:\n\n` : `", + "properties" : { + "additionalProperties" : { + "type" : "string" + } + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "mapping" ] + } + }, + "required" : [ "mappings", "type" ], + "title" : "mapping" + }, + "charFilterpersian" : { + "type" : "object", + "description" : "Filter that replaces instances of a zero-width non-joiner with an ordinary space. It is based on Lucene's PersianCharFilter.", + "externalDocs" : { + "description" : "PersianCharFilter", + "url" : "https://lucene.apache.org/core/8_0_0/analyzers-common/org/apache/lucene/analysis/fa/PersianCharFilter.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this character filter type.", + "enum" : [ "persian" ] + } + }, + "required" : [ "type" ], + "title" : "persian" + }, + "raw" : { + "type" : "object", + "description" : "Additional meta information captured about this event. The response returns this parameter as a JSON object when the query parameter `includeRaw=true`. The list of fields in the raw document may change. Don't rely on raw values for formal monitoring.", + "properties" : { + "_t" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "ALERT_AUDIT" + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration related to the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cid" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "cre" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event.", + "example" : "Alert Acknowledged" + }, + "gn" : { + "type" : "string", + "description" : "Human-readable label that identifies the project.", + "example" : "Test Project", + "maxLength" : 64, + "minLength" : 1 + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgName" : { + "type" : "string", + "description" : "Human-readable label that identifies the organization that contains the project.", + "example" : "Test Organization", + "maxLength" : 64, + "minLength" : 1 + }, + "severity" : { + "type" : "string", + "description" : "Severity of the event.", + "enum" : [ "INFO", "WARNING", "ERROR", "CRITICAL" ] + } + }, + "readOnly" : true + }, + "tokenFilterasciiFolding" : { + "type" : "object", + "description" : "Filter that converts alphabetic, numeric, and symbolic Unicode characters that are not in the Basic Latin Unicode block to their ASCII equivalents, if available.", + "externalDocs" : { + "description" : "Basic Latin Unicode block", + "url" : "https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "asciiFolding" ] + } + }, + "required" : [ "type" ], + "title" : "asciiFolding" + }, + "tokenFilterdaitchMokotoffSoundex" : { + "type" : "object", + "description" : "Filter that creates tokens for words that sound the same based on the Daitch-Mokotoff Soundex phonetic algorithm. This filter can generate multiple encodings for each input, where each encoded token is a 6 digit number.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- Operators where **fuzzy** is enabled. Atlas Search supports the **fuzzy** option only for the **autocomplete**, **term**, and **text** operators.", + "externalDocs" : { + "description" : "Daitch-Mokotoff Soundex phonetic algorithm", + "url" : "https://en.wikipedia.org/wiki/Daitch%E2%80%93Mokotoff_Soundex" + }, + "properties" : { + "originalTokens" : { + "type" : "string", + "default" : "include", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "daitchMokotoffSoundex" ] + } + }, + "required" : [ "type" ], + "title" : "daitchMokotoffSoundex" + }, + "tokenFilteredgeGram" : { + "type" : "object", + "description" : "Filter that tokenizes input from the left side, or \"edge\", of a text input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenFiltericuFolding" : { + "type" : "object", + "description" : "Filter that applies character folding from Unicode Technical Report #30.", + "externalDocs" : { + "description" : "Unicode Technical Report #30", + "url" : "http://www.unicode.org/reports/tr30/tr30-4.html" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuFolding" ] + } + }, + "required" : [ "type" ], + "title" : "icuFolding" + }, + "tokenFiltericuNormalizer" : { + "type" : "object", + "description" : "Filter that normalizes tokens using a standard Unicode Normalization Mode.", + "externalDocs" : { + "description" : "Unicode Normalization Mode", + "url" : "https://unicode.org/reports/tr15/" + }, + "properties" : { + "normalizationForm" : { + "type" : "string", + "default" : "nfc", + "description" : "Normalization form to apply.", + "enum" : [ "nfd", "nfc", "nfkd", "nfkc" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "icuNormalizer" ] + } + }, + "required" : [ "type" ], + "title" : "icuNormalizer" + }, + "tokenFilterlength" : { + "type" : "object", + "description" : "Filter that removes tokens that are too short or too long.", + "properties" : { + "max" : { + "type" : "integer", + "default" : 255, + "description" : "Number that specifies the maximum length of a token. Value must be greater than or equal to **min**." + }, + "min" : { + "type" : "integer", + "default" : 0, + "description" : "Number that specifies the minimum length of a token. This value must be less than or equal to **max**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "length" ] + } + }, + "required" : [ "type" ], + "title" : "length" + }, + "tokenFilterlowercase" : { + "type" : "object", + "description" : "Filter that normalizes token text to lowercase.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "lowercase" ] + } + }, + "required" : [ "type" ], + "title" : "lowercase" + }, + "tokenFilternGram" : { + "type" : "object", + "description" : "Filter that tokenizes input into n-grams of configured sizes. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Value that specifies the maximum length of generated n-grams. This value must be greater than or equal to **minGram**." + }, + "minGram" : { + "type" : "integer", + "description" : "Value that specifies the minimum length of generated n-grams. This value must be less than or equal to **maxGram**." + }, + "termNotInBounds" : { + "type" : "string", + "default" : "omit", + "description" : "Value that indicates whether to index tokens shorter than **minGram** or longer than **maxGram**.", + "enum" : [ "omit", "include" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "nGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenFilterregex" : { + "type" : "object", + "description" : "Filter that applies a regular expression to each token, replacing matches with a specified string.", + "properties" : { + "matches" : { + "type" : "string", + "description" : "Value that indicates whether to replace only the first matching pattern or all matching patterns.", + "enum" : [ "all", "first" ] + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression pattern to apply to each token." + }, + "replacement" : { + "type" : "string", + "description" : "Replacement string to substitute wherever a matching pattern occurs." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "regex" ] + } + }, + "required" : [ "matches", "pattern", "replacement", "type" ], + "title" : "regex" + }, + "tokenFilterreverse" : { + "type" : "object", + "description" : "Filter that reverses each string token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "reverse" ] + } + }, + "required" : [ "type" ], + "title" : "reverse" + }, + "tokenFiltershingle" : { + "type" : "object", + "description" : "Filter that constructs shingles (token n-grams) from a series of tokens. You can't use this token filter in synonym or autocomplete mapping definitions.", + "properties" : { + "maxShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the maximum number of tokens per shingle. This value must be greater than or equal to **minShingleSize**." + }, + "minShingleSize" : { + "type" : "integer", + "description" : "Value that specifies the minimum number of tokens per shingle. This value must be less than or equal to **maxShingleSize**." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "shingle" ] + } + }, + "required" : [ "maxShingleSize", "minShingleSize", "type" ], + "title" : "shingle" + }, + "tokenFiltersnowballStemming" : { + "type" : "object", + "description" : "Filter that stems tokens using a Snowball-generated stemmer.", + "externalDocs" : { + "description" : "Snowball-generated stemmer", + "url" : "https://snowballstem.org/" + }, + "properties" : { + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "snowballStemming" ] + } + }, + "required" : [ "stemmerName", "type" ], + "title" : "snowballStemming" + }, + "tokenFilterstopword" : { + "type" : "object", + "description" : "Filter that removes tokens that correspond to the specified stop words. This token filter doesn't analyze the stop words that you specify.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore the case of stop words when filtering the tokens to remove." + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "items" : { + "type" : "string" + } + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stopword" ] + } + }, + "required" : [ "tokens", "type" ], + "title" : "stopword" + }, + "tokenFiltertrim" : { + "type" : "object", + "description" : "Filter that trims leading and trailing whitespace from tokens.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "trim" ] + } + }, + "required" : [ "type" ], + "title" : "trim" + }, + "tokenizeredgeGram" : { + "type" : "object", + "description" : "Tokenizer that splits input from the left side, or \"edge\", of a text input into n-grams of given sizes. You can't use the edgeGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "edgeGram" + }, + "tokenizerkeyword" : { + "type" : "object", + "description" : "Tokenizer that combines the entire input as a single token.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "keyword" ] + } + }, + "required" : [ "type" ], + "title" : "keyword" + }, + "tokenizernGram" : { + "type" : "object", + "description" : "Tokenizer that splits input into text chunks, or \"n-grams\", of into given sizes. You can't use the nGram tokenizer in synonym or autocomplete mapping definitions.", + "properties" : { + "maxGram" : { + "type" : "integer", + "description" : "Characters to include in the longest token that Atlas Search creates." + }, + "minGram" : { + "type" : "integer", + "description" : "Characters to include in the shortest token that Atlas Search creates." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "edgeGram" ] + } + }, + "required" : [ "maxGram", "minGram", "type" ], + "title" : "nGram" + }, + "tokenizerregexCaptureGroup" : { + "type" : "object", + "description" : "Tokenizer that uses a regular expression pattern to extract tokens.", + "properties" : { + "group" : { + "type" : "integer", + "description" : "Index of the character group within the matching expression to extract into tokens. Use `0` to extract all character groups." + }, + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexCaptureGroup" ] + } + }, + "required" : [ "group", "pattern", "type" ], + "title" : "regexCaptureGroup" + }, + "tokenizerregexSplit" : { + "type" : "object", + "description" : "Tokenizer that splits tokens using a regular-expression based delimiter.", + "properties" : { + "pattern" : { + "type" : "string", + "description" : "Regular expression to match against." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "regexSplit" ] + } + }, + "required" : [ "pattern", "type" ], + "title" : "regexSplit" + }, + "tokenizerstandard" : { + "type" : "object", + "description" : "Tokenizer that splits tokens based on word break rules from the Unicode Text Segmentation algorithm.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "standard" ] + } + }, + "required" : [ "type" ], + "title" : "standard" + }, + "tokenizeruaxUrlEmail" : { + "type" : "object", + "description" : "Tokenizer that creates tokens from URLs and email addresses. Although this tokenizer uses word break rules from the Unicode Text Segmentation algorithm, we recommend using it only when the indexed field value includes URLs and email addresses. For fields that don't include URLs or email addresses, use the **standard** tokenizer to create tokens based on word break rules.", + "externalDocs" : { + "description" : "Unicode Text Segmentation Algorithm", + "url" : "https://www.unicode.org/L2/L2019/19034-uax29-34-draft.pdf" + }, + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "uaxUrlEmail" ] + } + }, + "required" : [ "type" ], + "title" : "uaxUrlEmail" + }, + "tokenizerwhitespace" : { + "type" : "object", + "description" : "Tokenizer that creates tokens based on occurrences of whitespace between words.", + "properties" : { + "maxTokenLength" : { + "type" : "integer", + "default" : 255, + "description" : "Maximum number of characters in a single token. Tokens greater than this length are split at this length into multiple tokens." + }, + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this tokenizer type.", + "enum" : [ "whitespace" ] + } + }, + "required" : [ "type" ], + "title" : "whitespace" + } + }, + "securitySchemes" : { + "DigestAuth" : { + "scheme" : "digest", + "type" : "http" + } + } + } +} \ No newline at end of file diff --git a/tools/cli/test/e2e/cli/changelog_test.go b/tools/cli/test/e2e/cli/changelog_test.go new file mode 100644 index 000000000..2092c20a2 --- /dev/null +++ b/tools/cli/test/e2e/cli/changelog_test.go @@ -0,0 +1,130 @@ +package cli + +import ( + "bytes" + "encoding/json" + "fmt" + "log" + "os" + "os/exec" + "strings" + "testing" + + "github.com/mongodb/openapi/tools/cli/internal/changelog" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestChangelog(t *testing.T) { + cliPath := NewBin(t) + + t.Run("Generate Changelog with new API Version", func(t *testing.T) { + base := NewChangelogBasePathNewAPIVersion(t) + revision := NewChangelogRevisionPathNewAPIVersion(t) + exemptions := NewChangelogExepmtionFilePathNewAPIVersion(t) + commandOut := getOutputFolder(t, "changelog") + + cmd := exec.Command(cliPath, + "changelog", + "create", + "-b", + base, + "-r", + revision, + "-e", + exemptions, + "-o", + commandOut, + ) + + var o, e bytes.Buffer + cmd.Stdout = &o + cmd.Stderr = &e + require.NoError(t, cmd.Run(), e.String()) + checkChangelogFilesAreTheSame(t, commandOut, NewChangelogOutputPathNewAPIVersion(t)) + }) +} + +func checkChangelogFilesAreTheSame(t *testing.T, cmdOutput, testOutput string) { + t.Helper() + log.Print("Checking file: changelog.json") + cmdChangelog := newEntriesFromPath(t, fmt.Sprintf("%s/%s", cmdOutput, "changelog.json")) + testChangelog := newEntriesFromPath(t, fmt.Sprintf("%s/%s", testOutput, "changelog.json")) + areEntriesTheSame(t, cmdChangelog, testChangelog) + + log.Print("Checking file: changelog-all.json") + cmdChangelogAll := newEntriesFromPath(t, fmt.Sprintf("%s/%s", cmdOutput, "internal/changelog-all.json")) + testChangelogAll := newEntriesFromPath(t, fmt.Sprintf("%s/%s", testOutput, "changelog-all.json")) + areEntriesTheSame(t, cmdChangelogAll, testChangelogAll) + compareVersions(t, cmdOutput, testOutput) +} + +func compareVersions(t *testing.T, cmdOutput, testOutput string) { + t.Helper() + + files, err := os.ReadDir(testOutput) + require.NoError(t, err) + + // Loop over each file in the test output folder + for _, fileName := range files { + if strings.Contains(fileName.Name(), "changelog.json") { + continue + } + + if strings.Contains(fileName.Name(), "changelog-all.json") { + continue + } + + log.Printf("Checking file: %s", fileName.Name()) + cmdPaths := newPathsFromPath(t, fmt.Sprintf("%s/%s/%s", cmdOutput, "version-diff", fileName.Name())) + testPaths := newPathsFromPath(t, fmt.Sprintf("%s/%s", testOutput, fileName.Name())) + arePathsTheSame(t, cmdPaths, testPaths) + } +} + +func areEntriesTheSame(t *testing.T, cmdEntries, testEntries []*changelog.Entry) { + t.Helper() + require.Equal(t, len(cmdEntries), len(testEntries)) + arePathsTheSame(t, cmdEntries[0].Paths, testEntries[0].Paths) +} + +func arePathsTheSame(t *testing.T, cmdPaths, testPaths []*changelog.Path) { + t.Helper() + require.Equal(t, len(cmdPaths), len(testPaths)) + for i, cmdPath := range cmdPaths { + assert.Equal(t, cmdPath.OperationID, testPaths[i].OperationID) + assert.Equal(t, cmdPath.HTTPMethod, testPaths[i].HTTPMethod) + assert.Equal(t, cmdPath.Tag, testPaths[i].Tag) + assert.Equal(t, cmdPath.StabilityLevel, testPaths[i].StabilityLevel) + assert.Equal(t, cmdPath.URI, testPaths[i].URI) + assert.Equal(t, cmdPath.ChangeType, testPaths[i].ChangeType) + assert.ElementsMatch(t, cmdPath.Changes, testPaths[i].Changes) + + for j, cmdVersion := range cmdPath.Versions { + assert.Equal(t, cmdVersion.Version, testPaths[i].Versions[j].Version) + assert.Equal(t, cmdVersion.ChangeType, testPaths[i].Versions[j].ChangeType) + assert.Equal(t, cmdVersion.StabilityLevel, testPaths[i].Versions[j].StabilityLevel) + assert.ElementsMatch(t, cmdVersion.Changes, testPaths[i].Versions[j].Changes) + } + } +} + +func newEntriesFromPath(t *testing.T, path string) []*changelog.Entry { + t.Helper() + contents, err := os.ReadFile(path) + require.NoError(t, err) + + var entries []*changelog.Entry + require.NoError(t, json.Unmarshal(contents, &entries)) + return entries +} + +func newPathsFromPath(t *testing.T, path string) []*changelog.Path { + t.Helper() + contents, err := os.ReadFile(path) + require.NoError(t, err) + + var paths []*changelog.Path + require.NoError(t, json.Unmarshal(contents, &paths)) + return paths +} diff --git a/tools/cli/test/e2e/cli/cli.go b/tools/cli/test/e2e/cli/cli.go index 3654947cb..fa72e8b63 100644 --- a/tools/cli/test/e2e/cli/cli.go +++ b/tools/cli/test/e2e/cli/cli.go @@ -31,6 +31,34 @@ func NewBaseSpecPath(t *testing.T) string { return cliPath } +func NewChangelogBasePathNewAPIVersion(t *testing.T) string { + t.Helper() + cliPath, err := filepath.Abs("../../data/changelog/new-version/base") + require.NoError(t, err) + return cliPath +} + +func NewChangelogRevisionPathNewAPIVersion(t *testing.T) string { + t.Helper() + cliPath, err := filepath.Abs("../../data/changelog/new-version/revision") + require.NoError(t, err) + return cliPath +} + +func NewChangelogExepmtionFilePathNewAPIVersion(t *testing.T) string { + t.Helper() + cliPath, err := filepath.Abs("../../data/changelog/new-version/exemptions.yaml") + require.NoError(t, err) + return cliPath +} + +func NewChangelogOutputPathNewAPIVersion(t *testing.T) string { + t.Helper() + cliPath, err := filepath.Abs("../../data/changelog/new-version/output") + require.NoError(t, err) + return cliPath +} + func NewAPIRegistrySpecPath(t *testing.T) string { t.Helper() cliPath, err := filepath.Abs("../../data/apiregistry_spec.json")